Skip to content

Commit db21f81

Browse files
authored
feat(cli): add llms.txt (#139)
## Description - Adds `llms.txt` to improve external agent ability to use the tool in this repo. ## Type of Change <!-- Mark the relevant option with an 'x' --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test updates ## Related Issues <!-- Link to related issues using #issue-number --> [Closes #](https://linear.app/runloop-ai/project/dx-and-devrel-f3a0ff86bff9/view/llm-docs-29c38157d690) - This is one part of a larger effort to improve llm performance on our repo ## Changes Made <!-- Describe the changes in detail --> ## Testing <!-- Describe how you tested your changes --> - [ ] I have tested locally - [ ] I have added/updated tests - [ ] All existing tests pass ## Checklist - [ ] My code follows the code style of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published ## Screenshots (if applicable) <!-- Add screenshots to help explain your changes --> ## Additional Notes <!-- Any additional information that reviewers should know -->
1 parent 9deeb1c commit db21f81

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

llms.txt

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Runloop CLI
2+
3+
> Runloop CLI (`rli`) is a TUI + CLI for the [Runloop.ai](https://runloop.ai) platform. It manages devboxes (cloud development environments), snapshots, blueprints, objects, network policies, secrets, and gateway configurations. It also includes an MCP server for AI assistant integration.
4+
5+
Important notes for AI agents:
6+
7+
- The `RUNLOOP_API_KEY` environment variable must be set before running any command
8+
- Use `-o json` or `-o yaml` flags for machine-readable output (most commands default to JSON for `list` and `get` operations)
9+
- Run `rli --help` for top-level help, `rli <command> --help` for command group help, and `rli <command> <subcommand> --help` for detailed flag documentation
10+
- Command aliases exist for convenience: `devbox`/`d`, `snapshot`/`snap`, `blueprint`/`bp`, `object`/`obj`, `network-policy`/`np`, `secret`/`s`, `gateway-config`/`gwc`, `mcp-config`/`mcpc`
11+
12+
## Installation
13+
14+
```bash
15+
npm install -g @runloop/rl-cli
16+
# or
17+
pnpm add -g @runloop/rl-cli
18+
```
19+
20+
Then configure authentication:
21+
22+
```bash
23+
export RUNLOOP_API_KEY=your_api_key_here
24+
```
25+
26+
Get your API key from [https://runloop.ai/settings](https://runloop.ai/settings).
27+
28+
## Core Commands
29+
30+
- `rli devbox list` - List all devboxes (filter with `-s running`, `-s suspended`, etc.)
31+
- `rli devbox create --name <name>` - Create a new devbox
32+
- `rli devbox exec <id> <command...>` - Execute a command in a devbox
33+
- `rli devbox ssh <id>` - SSH into a devbox
34+
- `rli devbox scp <src> <dst>` - Copy files to/from a devbox (e.g., `rli devbox scp dbx_id:/remote ./local`)
35+
- `rli devbox rsync <src> <dst>` - Sync files to/from a devbox using rsync
36+
- `rli devbox delete <id>` - Shutdown and delete a devbox
37+
- `rli snapshot list` - List snapshots
38+
- `rli snapshot create <devbox-id>` - Create a snapshot
39+
- `rli blueprint list` - List available blueprints
40+
41+
Use the help or explore this repo to discover the full set of commands.
42+
43+
## Docs
44+
45+
- [README](https://github.com/runloopai/rl-cli/blob/main/README.md): Installation, setup, and complete command reference with examples
46+
- [Full Documentation](https://docs.runloop.ai/docs/tools/rl-cli): Official Runloop CLI documentation
47+
48+
## MCP Integration
49+
50+
- [MCP README](https://github.com/runloopai/rl-cli/blob/main/MCP_README.md): Model Context Protocol server setup for AI assistants
51+
- [Claude Setup](https://github.com/runloopai/rl-cli/blob/main/CLAUDE_SETUP.md): Step-by-step guide for Claude Desktop integration
52+
- [MCP Commands](https://github.com/runloopai/rl-cli/blob/main/MCP_COMMANDS.md): Quick reference for MCP tools
53+
54+
## Optional
55+
56+
- [Contributing](https://github.com/runloopai/rl-cli/blob/main/CONTRIBUTING.md): Guidelines for contributing to the CLI
57+
- [Changelog](https://github.com/runloopai/rl-cli/blob/main/CHANGELOG.md): Version history and release notes

0 commit comments

Comments
 (0)