Use Repositories to automatically set up a Runloop Devbox environment with code from your Github repositories. When creating a Repository, Runloop will inspect the code and identify the steps necessary to set up the environment, such as installing dependencies, and running lint or tests. When the inspection is complete, a Blueprint is created containing your code complete with dependencies installed.

1

Create the Repository

Create the Repository using the Runloop Dashboard or the API, providing your Github repository name and owner.

curl -X POST 'https://api.runloop.ai/v1/repositories' \
  -H "Authorization: Bearer $RUNLOOP_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<repository_name>",
    "owner": "<repository_owner>"
  }'
2

View the inspection

Once the Repository is created, Runloop will begin inspecting your code. View the inspection to see the set of tools and commands that were discovered.

curl --request GET \
  --url https://api.runloop.pro/v1/repositories/<repository_id>/versions \ 
  --header "Authorization: Bearer $RUNLOOP_API_KEY"

The inspection object will contain the results of your inspection, including information about the code, and also a blueprint ID that can be used to create a devbox with your code and environment already set up.

{
  "commit_sha":"eae01f9b283de0a93d4ee6a1a2c54548990e01f3",
  "analyzed_at":1739399583870,
  "repository_setup_details": {
    "blueprint_id":"bpt_2z4tIp5n29Ur9JA5CeDUy",
    "env_initialization_command":"",
    "workspace_setup":["npm install --global yarn"]
  },"extracted_tools": {
    "package_manager":"yarn",
    "commands":{
      "lint":"yarn run lint",
      "test":"yarn run test",
      "install":"yarn --immutable",
      "build":"yarn run build"
    }
  },
  "status":"success"
}
3

Use the blueprint to launch a Devbox containing your code and dependencies

Using the blueprint_id from the inspction, wait for the Blueprint to complete building.

Use the retrieve endpoint to check the status of the Blueprint.

When the Blueprint is build_complete, create a Devbox using it. Your code will be cloned into the Devbox and the environment will contain the dependencies and tools discovered during the inspection.

Was this page helpful?