doc: added documentation for inti command for terminal

[AditM99]

Summary

-Updated the documentation for the init command

Type

Docs>

Testing

Only documentation update no testing

Checklist

• Commit messages follow conventional commits
• No secrets or credentials included
• Wiki updated (if applicable)
• Breaking changes documented (if applicable)

Linked Issue

Fixes #656

Summary by CodeRabbit

• Documentation
  • Added documentation for the new rocketride init command for scaffolding project content with agent and documentation stubs.
  • Documented command flags (--agent, --no-agents, --force, --no-overwrite) for controlling initialization behavior.
  • Clarified configuration options for other commands including --uri and --apikey flags and environment variable support.

[coderabbitai]

📝 Walkthrough

Walkthrough

The Python client documentation is updated to document the new rocketride init CLI command, which scaffolds .rocketride/ project content including agent stubs. The documentation explains supported flags and idempotent re-run behavior.

Changes

CLI Command Documentation

Layer / File(s)	Summary
Command Reference docs/README-python-client.md	Added rocketride init command documentation alongside existing rocketride start pipeline.json command. Includes description of scaffolding behavior, agent stub handling, idempotent re-runs via HTML comments, and supported --agent, --no-agents, --force, and --no-overwrite flags. Also clarifies that other commands accept --uri/--apikey flags or read from environment variables.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• docs: improve package READMEs with consistent structure and richer co… #274: Modifies the same docs/README-python-client.md file and may need coordinate review for consistency.

Suggested labels

docs

Suggested reviewers

• jmaionchi
• stepmikhaylov
• Rod-Christensen

Poem

🐰 Hops with glee through markdown lines,
rocketride init now shines!
Scaffolds and stubs, so neat and tight,
Idempotent flags burning bright,
Docs complete—developers delight! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title mentions 'inti command' which appears to be a typo for 'init command', and the documentation confirms the actual command is 'rocketride init'. The title is related to the change but contains a spelling error that impacts clarity.
Linked Issues check	✅ Passed	The documentation updates fulfill the core requirement of documenting the rocketride init command including its flags (--agent, --no-agents, --force, --no-overwrite) and explaining behavior parity with VS Code extension.
Out of Scope Changes check	✅ Passed	All changes are documentation updates to README-python-client.md directly related to the init command feature. No unrelated code changes or out-of-scope modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

⚔️ Resolve merge conflicts

• Resolve merge conflict in branch docs/RR-656-cli-init-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

No description provided.

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/README-python-client.md (1)

530-540: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

rocketride init is documented but not implemented in the current CLI.

Line 530 and Line 540 describe rocketride init and flags that are not registered in packages/client-python/src/rocketride/cli/main.py (no init subcommand, no --agent/--no-agents/--force/--no-overwrite). This will make documented commands fail for users.

Proposed docs-only correction (until CLI support lands)

-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
 rocketride list                              # List all active tasks
 rocketride events ALL --token <token>        # Stream task events
 rocketride rrext_store get_all_projects      # List stored projects

-`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).
+<!-- `rocketride init` docs should be added once the Python CLI actually registers the command and flags. -->

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/README-python-client.md` around lines 530 - 540, Docs advertise a
non-existent CLI feature: update the README to avoid promising the unimplemented
"rocketride init" subcommand (and flags --agent, --no-agents, --force,
--no-overwrite) or add a clear "not yet implemented" / "coming soon" note for
it; alternatively, implement the missing subcommand in the CLI entrypoint
(rocketride.cli.main) that wires an "init" subparser and handles those flags,
but until implementation lands prefer the docs-only correction to prevent users
from following broken instructions.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/README-python-client.md`:
- Around line 530-540: Docs advertise a non-existent CLI feature: update the
README to avoid promising the unimplemented "rocketride init" subcommand (and
flags --agent, --no-agents, --force, --no-overwrite) or add a clear "not yet
implemented" / "coming soon" note for it; alternatively, implement the missing
subcommand in the CLI entrypoint (rocketride.cli.main) that wires an "init"
subparser and handles those flags, but until implementation lands prefer the
docs-only correction to prevent users from following broken instructions.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 21b391e0-6ede-4a88-a385-b7077ca00879

📥 Commits

Reviewing files that changed from the base of the PR and between 5d9963f and 7c8462d.

📒 Files selected for processing (1)

• docs/README-python-client.md

[asclearuc]

Thank you.
Make it a part of #727
Closing it.