Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
Show 25 variants Setup { force: bool, dry_run: bool, skip_skills: bool, skip_hooks: bool, skip_claude_md: bool, }, Reconfigure, Backfill { limit: usize, dry_run: bool, }, Init { no_sync: bool, no_hooks: bool, provider: Option<String>, model: Option<String>, backfill: bool, }, Context { action: ContextAction, }, Read { path: String, anchor: Option<String>, lines: Option<String>, }, Annotate { commit: String, live: bool, squash_sources: Option<String>, amend_source: Option<String>, summary: Option<String>, json_input: Option<String>, auto: bool, }, Flag { path: String, anchor: Option<String>, reason: String, }, Correct { sha: String, region: String, field: String, remove: Option<String>, amend: Option<String>, }, Sync { action: SyncAction, }, Export { output: Option<String>, }, Import { file: String, force: bool, dry_run: bool, }, Doctor { json: bool, staleness: bool, }, Deps { path: String, anchor: Option<String>, format: String, max_results: u32, scan_limit: u32, compact: bool, }, History { path: String, anchor: Option<String>, limit: u32, format: String, compact: bool, }, Show { path: String, anchor: Option<String>, commit: String, no_tui: bool, }, Schema { name: String, }, Contracts { path: String, anchor: Option<String>, format: String, compact: bool, }, Decisions { path: Option<String>, format: String, compact: bool, }, Summary { path: String, anchor: Option<String>, format: String, compact: bool, }, Lookup { path: String, anchor: Option<String>, format: String, compact: bool, }, Status { format: String, }, Note { text: Option<String>, list: bool, clear: bool, }, Web { port: u16, open: bool, }, Knowledge { action: KnowledgeAction, },
}

Variants§

§

Setup

One-time machine-wide setup (provider, skills, hooks, CLAUDE.md)

Fields

§force: bool

Overwrite existing files without prompting

§dry_run: bool

Print what would be done without writing

§skip_skills: bool

Skip installing Claude Code skills

§skip_hooks: bool

Skip installing Claude Code hooks

§skip_claude_md: bool

Skip modifying ~/.claude/CLAUDE.md

§

Reconfigure

Rerun the LLM provider selection prompt

§

Backfill

Annotate historical commits that lack Chronicle annotations

Fields

§limit: usize

Maximum number of commits to annotate

§dry_run: bool

List commits that would be annotated without calling the LLM

§

Init

Initialize chronicle in the current repository

Fields

§no_sync: bool

Disable notes sync (sync is enabled by default)

§no_hooks: bool

Skip hook installation

§provider: Option<String>

LLM provider to use

§model: Option<String>

LLM model to use

§backfill: bool

Run backfill after init (annotate last 20 commits)

§

Context

Manage annotation context

Fields

§

Read

Read annotations for a file

Fields

§path: String

File path to read annotations for

§anchor: Option<String>

Filter by AST anchor name

§lines: Option<String>

Filter by line range (format: start:end)

§

Annotate

Annotate a specific commit

Fields

§commit: String

Commit to annotate (default: HEAD)

§live: bool

Read AnnotateInput JSON from stdin (live annotation path, zero LLM cost)

§squash_sources: Option<String>

Comma-separated source commit SHAs for squash synthesis (CI usage)

§amend_source: Option<String>

Old commit SHA to migrate annotation from (amend re-annotation)

§summary: Option<String>

Quick annotation: provide summary directly on command line

§json_input: Option<String>

Provide full annotation JSON on command line

§auto: bool

Auto-annotate using the commit message as summary

§

Flag

Flag a region annotation as potentially inaccurate

Fields

§path: String

File path relative to repository root

§anchor: Option<String>

Optional AST anchor name to scope the flag to a specific region

§reason: String

Reason for flagging this annotation

§

Correct

Apply a precise correction to a specific annotation field

Fields

§sha: String

Commit SHA of the annotation to correct

§region: String

AST anchor name of the region within the annotation

§field: String

Annotation field to correct (intent, reasoning, constraints, risk_notes, semantic_dependencies, tags)

§remove: Option<String>

Specific value to remove or mark as incorrect

§amend: Option<String>

Replacement or amendment text

§

Sync

Manage notes sync with remotes

Fields

§action: SyncAction
§

Export

Export annotations as JSONL

Fields

§output: Option<String>

Write to file instead of stdout

§

Import

Import annotations from a JSONL file

Fields

§file: String

JSONL file to import

§force: bool

Overwrite existing annotations

§dry_run: bool

Show what would be imported without writing

§

Doctor

Run diagnostic checks on the chronicle setup

Fields

§json: bool

Output as JSON

§staleness: bool

Include annotation staleness check (scans recent annotations)

§

Deps

Find code that depends on a given file/anchor (dependency inversion)

Fields

§path: String

File path to query

§anchor: Option<String>

AST anchor name to query

§format: String

Output format (json or pretty)

§max_results: u32

Maximum number of results to return

§scan_limit: u32

Maximum number of commits to scan

§compact: bool

Omit metadata (schema, query echo, stats) from JSON output

§

History

Show annotation timeline for a file/anchor across commits

Fields

§path: String

File path to query

§anchor: Option<String>

AST anchor name to query

§limit: u32

Maximum number of timeline entries

§format: String

Output format (json or pretty)

§compact: bool

Omit metadata (schema, query echo, stats) from JSON output

§

Show

Interactive TUI explorer for annotated source code

Fields

§path: String

File path to show

§anchor: Option<String>

Focus on a specific AST anchor

§commit: String

Commit to show file at

§no_tui: bool

Force non-interactive plain-text output

§

Schema

Print JSON Schema for annotation types (self-documenting for AI agents)

Fields

§name: String

Schema name: annotate-input, annotation

§

Contracts

Query contracts and dependencies for a file/anchor (“What must I not break?”)

Fields

§path: String

File path to query

§anchor: Option<String>

AST anchor name to query

§format: String

Output format (json or pretty)

§compact: bool

Omit metadata (schema, query echo, stats) from JSON output

§

Decisions

Query design decisions and rejected alternatives (“What was decided?”)

Fields

§path: Option<String>

File path to scope decisions to (omit for all)

§format: String

Output format (json or pretty)

§compact: bool

Omit metadata (schema, query echo) from JSON output

§

Summary

Show condensed annotation summary for a file

Fields

§path: String

File path to query

§anchor: Option<String>

Filter to a specific AST anchor

§format: String

Output format (json or pretty)

§compact: bool

Omit metadata (schema, query echo, stats) from JSON output

§

Lookup

One-stop context lookup for a file (contracts + decisions + history)

Fields

§path: String

File path to query

§anchor: Option<String>

AST anchor name

§format: String

Output format (json or pretty)

§compact: bool

Compact output (payload only)

§

Status

Show annotation status and coverage for the repository

Fields

§format: String

Output format

§

Note

Stage a note for the next annotation (captured context during work)

Fields

§text: Option<String>

The note text to stage (omit to list or clear)

§list: bool

List current staged notes

§clear: bool

Clear all staged notes

§

Web

Launch web viewer for browsing annotations

Fields

§port: u16

Port to listen on

§open: bool

Open browser automatically

§

Knowledge

Manage repo-level knowledge (conventions, boundaries, anti-patterns)

Fields

Trait Implementations§

Source§

impl FromArgMatches for Commands

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more