CLI

Previous Next

cli

Dorgy automatically organizes your files using AI-assisted workflows.

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

  --version   Show the version and exit.
  -h, --help  Show this message and exit.

cli config

Manage Dorgy configuration files and overrides.

Usage:

cli config [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

cli config edit

Open the configuration file in an interactive editor session.

Raises: click.ClickException: If the edited content fails validation.

Usage:

cli config edit [OPTIONS]

Options:

  -h, --help  Show this message and exit.

cli config set

Persist a configuration value expressed as a dotted KEY.

Args: key: Dotted configuration path to update. value: Raw YAML string representing the new value.

Raises: click.ClickException: If the update fails validation or parsing.

Usage:

cli config set [OPTIONS] KEY

Options:

  --value TEXT  Value to assign to KEY.  [required]
  -h, --help    Show this message and exit.

cli config view

Display the effective configuration after applying precedence rules.

Args: no_env: When True, exclude environment overrides from the rendered config.

Raises: click.ClickException: If the configuration cannot be loaded.

Usage:

cli config view [OPTIONS]

Options:

  --no-env    Ignore environment overrides when displaying output.
  -h, --help  Show this message and exit.

cli mv

Move or rename tracked files within an organized collection.

Args: ctx: Click context tracking global mode flags. source: Source path to move. destination: Destination path for the move. conflict_strategy: Conflict resolution strategy name. dry_run: Indicates whether to preview without mutating files. json_output: Indicates whether JSON output mode is active. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested.

Raises: click.ClickException: When validation fails before executing the move.

Usage:

cli mv [OPTIONS] SOURCE DESTINATION

Options:

  --conflict-strategy [append_number|timestamp|skip]
                                  Conflict resolution strategy when the
                                  destination already exists.
  --dry-run                       Preview move/rename without applying
                                  changes.
  --json                          Emit JSON describing the move operation.
  --summary                       Only emit summary lines.
  --quiet                         Suppress non-error output.
  -h, --help                      Show this message and exit.

cli org

Organize files rooted at PATH using the configured ingestion pipeline.

Args: ctx: Click context tracking global mode flags. path: Root directory to organize. recursive: Whether to include subdirectories during scanning. classify_prompt: Inline classification guidance provided via CLI. classify_prompt_file: Path to a file containing classification guidance. structure_prompt: Inline structure guidance provided via CLI. structure_prompt_file: Path to a structure guidance file. output: Optional destination root for organized files. dry_run: Indicates whether to preview changes without mutating files. json_output: Indicates whether JSON output mode is active. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested. with_search: Forces search indexing after organization. without_search: Skips search indexing regardless of configuration.

Raises: click.ClickException: When validation fails before executing the pipeline.

Usage:

cli org [OPTIONS] PATH

Options:

  -r, --recursive               Include all subdirectories.
  --classify-prompt-file FILE   Read classification guidance from a text file.
  --classify-prompt TEXT        Provide extra classification guidance.
  --structure-prompt-file FILE  Read extra structure instructions from a file.
  --structure-prompt TEXT       Provide extra structure instructions.
  --output DIRECTORY            Directory for organized files.
  --dry-run                     Preview changes without modifying files.
  --json                        Emit JSON describing proposed changes.
  --summary                     Only emit summary lines.
  --quiet                       Suppress non-error output.
  --with-search                 Build or update the local search index after
                                organization completes.
  --without-search              Skip search indexing for this run, overriding
                                config and prior state.
  -h, --help                    Show this message and exit.

Search within an organized collection's state metadata.

Args: ctx: Click context tracking global mode flags. path: Collection root to search. query: Free-text query string. name: Filename glob pattern filter. tags: Comma-separated tag filter string. categories: Comma-separated category filter string. before: Upper bound on modification timestamp. after: Lower bound on modification timestamp. needs_review: Optional needs-review filter flag. limit: Maximum number of results to display. contains: Substring filter for document contents. init_store: Whether to rebuild the search store from disk before querying. drop_store: Whether to drop the search store and disable search. reindex: Whether to rebuild the search store from scratch. json_output: Indicates whether JSON output mode is active. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested.

Raises: click.ClickException: When validation fails before performing the search.

Usage:

cli search [OPTIONS] PATH

Options:

  --search TEXT                  Free-text search across paths, tags, and
                                 categories.
  --name TEXT                    Filename glob filter (e.g., '*.pdf').
  --tags TEXT                    Comma-separated tag filters (matches all
                                 provided tags).
  --categories TEXT              Comma-separated category filters (matches all
                                 provided categories).
  --before TEXT                  Return results with modified time before this
                                 ISO 8601 timestamp.
  --after TEXT                   Return results with modified time on or after
                                 this ISO 8601 timestamp.
  --needs-review / --any-review  Filter results by needs-review flag (default
                                 is to include all).
  --limit INTEGER                Maximum number of results to return (defaults
                                 to configuration).
  --contains TEXT                Substring filter for document contents.
  --init-store                   Rebuild the Chromadb store from disk.
  --drop-store                   Delete the Chromadb store and disable search.
  --reindex                      Drop and rebuild the Chromadb store for the
                                 collection.
  --json                         Emit search results as JSON.
  --summary                      Only emit summary lines.
  --quiet                        Suppress non-error output.
  -h, --help                     Show this message and exit.

cli status

Display a summary of the collection state for PATH.

Args: ctx: Click context tracking global mode flags. path: Collection root to summarize. json_output: Indicates whether JSON output mode is active. history_limit: Maximum number of history events to display. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested.

Raises: click.ClickException: When validation fails before reading the state.

Usage:

cli status [OPTIONS] PATH

Options:

  --json             Emit status information as JSON.
  --history INTEGER  Number of recent history entries to include (defaults to
                     configuration).
  --summary          Only emit summary lines.
  --quiet            Suppress non-error output.
  -h, --help         Show this message and exit.

cli undo

Rollback the last organization plan applied to PATH.

Args: ctx: Click context tracking global mode flags. path: Collection root to roll back. dry_run: Indicates whether to preview without mutating files. json_output: Indicates whether JSON output mode is active. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested.

Raises: click.ClickException: When validation fails before performing the rollback.

Usage:

cli undo [OPTIONS] PATH

Options:

  --dry-run   Preview rollback without applying it.
  --json      Emit JSON describing the rollback plan.
  --summary   Only emit summary lines.
  --quiet     Suppress non-error output.
  -h, --help  Show this message and exit.

cli version

Display the installed Dorgy version and environment details.

Args: ctx: Click context carrying CLI mode flags. json_output: Indicates whether JSON output is requested. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested.

Usage:

cli version [OPTIONS]

Options:

  --json      Emit version information as JSON.
  --summary   Only emit the version summary line.
  --quiet     Suppress non-error output.
  -h, --help  Show this message and exit.

cli watch

Continuously monitor PATHS and organize changes as they arrive.

Args: ctx: Click context tracking global mode flags. paths: Collection roots to monitor. recursive: Whether to traverse subdirectories while watching. classify_prompt: Inline classification guidance provided via CLI. classify_prompt_file: Path to a file containing classification guidance. structure_prompt: Inline structure guidance provided via CLI. structure_prompt_file: Path to a structure guidance file. output: Optional destination root used when copying organized files. dry_run: Indicates whether to preview changes without mutating files. debounce: Optional debounce interval override in seconds. json_output: Indicates whether JSON output mode is active. summary_mode: Indicates whether summary-only output is requested. quiet: Indicates whether quiet mode is requested. allow_deletions: Whether deletions are permitted for watch batches. once: Runs a single batch when True instead of streaming. with_search: Forces search indexing after each batch. without_search: Skips search indexing regardless of configuration.

Raises: click.ClickException: When validation fails before launching the watch.

Usage:

cli watch [OPTIONS] [PATHS]...

Options:

  -r, --recursive               Include subdirectories for monitoring.
  --classify-prompt-file FILE   Read classification guidance from a text file.
  --classify-prompt TEXT        Provide extra classification guidance.
  --structure-prompt-file FILE  Read extra structure instructions from a file.
  --structure-prompt TEXT       Provide extra structure instructions.
  --output DIRECTORY            Destination root when copying organized files.
  --dry-run                     Preview actions without mutating files.
  --debounce FLOAT              Override debounce interval in seconds.
  --json                        Emit JSON describing watch batches.
  --summary                     Only emit summary lines.
  --quiet                       Suppress non-error output.
  --allow-deletions             Allow watch runs to drop state entries when
                                files are deleted or leave the collection.
  --once                        Process current contents once and exit.
  --with-search                 Build or update the local search index after
                                each watch batch.
  --without-search              Skip search indexing for this run, overriding
                                config and prior state.
  -h, --help                    Show this message and exit.
Troubleshooting API