​
Key Features

  • Easy interaction with Runloop API
  • Helpful for blueprint testing and devbox management
  • Debugging tool for running devboxes
  • Potential tool for AI agents to interact with Runloop

​
Setting Up the CLI

The Runloop CLI is written in Python and wraps the Runloop Python SDK.

To set up the Runloop CLI:

  1. Visit the Runloop CLI GitHub page
  2. Follow the installation instructions provided in the repository

​
Essential CLI Commands

Once set up and validated, the CLI offers a range of helpful commands:

​
Create a Blueprint

rl blueprint create --system_setup_commands "sudo apt install cowsay -y" --name cowsay-devbox

This command creates a new blueprint named cowsay-devbox with the cowsay package installed. The response from the cli will include an id for the blueprint.

​
Create a Devbox

rl devbox create --entrypoint "/usr/games/cowsay runloop" --blueprint_id "<bpt_your_blueprint>"

This creates a devbox using a specified blueprint and sets an entrypoint command.

​
Monitor Devbox Logs

watch rl devbox logs --id <dbx_your_id>

This command allows you to watch the logs of a running devbox in real-time.

​
SSH into a Devbox

For more advanced use cases, you can use the CLI to SSH into your Devbox. For detailed instructions, refer to our SSH Access guide.

​
Contributing

The Runloop CLI is open-source, and we enthusiastically welcome contributions and feedback from our community. To contribute:

  1. Visit our GitHub repository
  2. Fork the repository
  3. Make your changes
  4. Submit a pull request

We appreciate all forms of contribution, from bug reports and feature requests to code contributions and documentation improvements.

​
Getting Help

If you encounter any issues or have questions about using the Runloop CLI:

  1. Check the CLI documentation for detailed usage instructions
  2. Open an issue on the GitHub repository for bug reports or feature requests
  3. Reach out to our team for additional assistance