Skip to content

doc: added documentation for inti command for terminal #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AditM99 wants to merge 1 commit into from
Closed

doc: added documentation for inti command for terminal #750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/README-python-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,8 @@ asyncio.run(main())
The `rocketride` command is installed automatically with the package.

```bash
rocketride start pipeline.json # Start a pipeline
rocketride init # Scaffold .rocketride/ in the current directory
rocketride start pipeline.json # Start a pipeline
rocketride upload *.pdf --token <token> # Upload files to a running pipeline
rocketride status --token <token> # Monitor task progress
rocketride stop --token <token> # Terminate a running task
Expand All @@ -536,7 +537,9 @@ rocketride events ALL --token <token> # Stream task events
rocketride rrext_store get_all_projects # List stored projects
```

All commands accept `--uri` and `--apikey` flags, or read from environment variables.
`rocketride init` scaffolds `.rocketride/docs/` and installs a stub for the coding agent it detects (Cursor, Claude Code, Windsurf, Copilot, `CLAUDE.md`, or `AGENTS.md`). Re-runs are idempotent — stubs use `<!-- ROCKETRIDE:BEGIN/END -->` markers, so content outside is preserved. Flags: `--agent <name>` (repeatable; `all` for every stub), `--no-agents` (docs only), `--force` / `--no-overwrite` (mutually exclusive; default is to prompt).

All other commands accept `--uri` and `--apikey` flags, or read from environment variables.

## Configuration

Expand Down
Loading