Skip to content

docs(cli): clarify --project/--schemas precede the subcommand (#500) #503

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

Merged
avrabe merged 1 commit into from
Jun 6, 2026
Merged

docs(cli): clarify --project/--schemas precede the subcommand (#500) #503

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
14 changes: 8 additions & 6 deletions rivet-cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,17 @@ fn check_for_updates() {
#[derive(Parser)]
#[command(name = "rivet", about = "SDLC artifact traceability and validation", version = build_version())]
struct Cli {
/// Path to the project directory (containing rivet.yaml).
/// NOTE: not `global` — clap debug-asserts when a global arg coexists with
/// subcommands that take positionals (next-id/link/snapshot diff/…), so
/// `--project` must precede the subcommand: `rivet -p X validate`, not
/// `rivet validate -p X`. See #500 (reverted REQ-209).
// Not `global`: clap debug-asserts when a global arg coexists with
// subcommands that take positionals (next-id <type>, link <a> <b>,
// snapshot diff <x>, …). So this must precede the subcommand. See #500
// (REQ-209 attempted `global = true` and was reverted in #502).
/// Path to the project directory (containing rivet.yaml). Pass it BEFORE the
/// subcommand: `rivet -p <dir> validate` (not `rivet validate -p <dir>`).
#[arg(short, long, default_value = ".")]
project: PathBuf,

/// Path to schemas directory (precedes the subcommand, like `--project`).
/// Path to schemas directory. Like `--project`, pass it BEFORE the
/// subcommand (`rivet --schemas <dir> validate`).
#[arg(long)]
schemas: Option<PathBuf>,

Expand Down
Loading