Config
The dorsal config command group helps you view the settings for dorsal, and manage color themes for the CLI.
This guide covers the eight sub-commands:
show: View the current configuration.theme list: List all available color themes.theme set: Set the default color theme.pipeline show: Show the annotation model pipeline.pipeline check: Debug/fix missing model paths in the config.pipeline activate: Activate a (deactivated) model in the pipeline config.pipeline deactivate: Deactivate a model in the pipeline config.pipeline remove: Remove a model from the pipeline config.
dorsal config show
This command displays the current dorsal configuration, including login status, API key source, and important paths.
Example
Run dorsal config show to see your active settings.
This will display a panel with your configuration details:
╭──────────────────────────────────── Dorsal Configuration ───────────────────────────────────╮
│ Current Theme: default │
│ Logged-In User: user@example.com │
│ API Key Status: Set (from project config: /home/user/projects/dorsal/dorsal.toml) │
│ API URL: http://api.dorsalhub.com │
│ Reports Path: /home/user/.dorsal │
│ Active Config File: /home/user/projects/dorsal/dorsal.toml │
│ Global Config File: /home/user/.dorsal/dorsal.toml │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯
Options
-
Output the configuration as a raw JSON object:
CLI Docs
Usage: dorsal config show [OPTIONS]
Displays the current configuration status and paths.
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --json Output the configuration as a raw JSON object. │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────╯
dorsal config theme list
This command lists all available built-in and custom color themes, with a small preview for each.
Custom themes can be defined by creating a palettes.json file in your ~/.dorsal directory.
Example
Run dorsal config theme list to see all available themes:
Output (except in color and not truncated):
╭────────────── Theme Configuration ───────────────╮
│ │
│ Available Themes │
│ │
│ Built-in Themes │
│ ╭─────────────── default ───────────────╮ │
│ │ Key: Primary Value │ │
│ │ Hash: a1b2c3d4e5f62a3b4c... │ │
│ │ Tags: public_tag (public) │ │
│ │ private_tag (private) │ │
│ ╰───────────────────────────────────────╯ │
│ ╭──────────── high_contrast ────────────╮ │
│ │ Key: Primary Value │ │
│ │ Hash: a1b2c3d4e5f62a3b4c... │ │
│ │ Tags: public_tag (public) │ │
│ │ private_tag (private) │ │
│ ╰───────────────────────────────────────╯ │
│ ... │
│ │
│ dorsal config theme set <name> to set a theme. │
│ │
│ Or use the --theme flag before another command │
│ e.g. dorsal --theme mono file push ...` │
│ │
╰──────────────────────────────────────────────────╯
The current supported set of themes:
default: A standard dark console theme.dracula: A dark theme based on the Dracula color palette.high_contrast: A theme designed for high visibility and accessibility.light: A theme optimized for light (white/pale) terminal backgrounds.mono: A monochrome theme using only black, white, and shades of gray.neon: A vibrant theme featuring bright, neon-inspired colors.
CLI Docs
Usage: dorsal config theme list [OPTIONS]
Lists all available built-in and custom color themes.
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────╯
dorsal config theme set
This command sets the default color theme for your CLI. The setting is saved to your configuration file.
Example
Change your theme by running dorsal config theme set with the name of theme you want to change to:
On success, you'll see a confirmation:
CLI Docs
Usage: dorsal config theme set [OPTIONS] THEME_NAME
Sets the default color theme, saved to the config file.
╭─ Arguments ─────────────────────────────────────────────────────────────────╮
│ * theme_name TEXT The name of the theme to set as the default. │
│ [required] │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────╯
dorsal config pipeline show
This command displays the current effective annotation model pipeline. It shows the order of execution, model status, and dependencies as a table.
Example
This will display the status table:
╭────────────────────────────────────────────── Annotation Model Pipeline ───────────────────────────────────────────────╮
│ Idx Status Model Name Module Schema ID Dependencies │
│ 0 Default FileCoreAnnotationModel dorsal.file.annotation_models file/base None │
│ 1 Active MediaInfoAnnotationModel dorsal.file.annotation_models file/mediainfo media_type │
│ 2 Active PDFAnnotationModel dorsal.file.annotation_models file/pdf media_type │
│ 3 Active EbookAnnotationModel dorsal.file.annotation_models file/ebook media_type │
│ 4 Active OfficeDocumentAnnotationModel dorsal.file.annotation_models file/office media_type │
╰──────────────────────────────────────────────────── Total Models: 5 ───────────────────────────────────────────────────╯
CLI Docs
Usage: dorsal config pipeline show [OPTIONS]
Show the current effective pipeline configuration.
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────╯
dorsal config pipeline check
Verifies that all registered models can be imported correctly. This is useful for debugging ModuleNotFoundError or broken paths in your config.
Example
If broken models are found, it will output:
Found 1 broken models:
• Index 2: LegacyModel - No module named 'old_project'
Run with --fix to automatically remove these models.
Fixing Broken Paths
You can use the --fix flag to automatically remove models that fail to import:
CLI Docs
Usage: dorsal config pipeline check [OPTIONS]
Verifies that all registered models can be imported.
╭─ Options ───────────────────────────────────────────────────────────────────╮
│ --fix Automatically remove models with broken import paths. │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────╯
dorsal config pipeline activate / deactivate / remove
These commands manage the state of specific models within the pipeline.
You can select a model by its Index (Idx field in dorsal config pipeline show) or its Name.
Commands
dorsal config pipeline activate <target>: Enable a previously deactivated model.dorsal config pipeline deactivate <target>: Disable a model without removing it from the configuration.dorsal config pipeline remove <target>: Permanently remove a model from the pipeline.
Examples
Deactivate a model by index:
Activate a model by name:
Remove a model:
CLI Docs
Usage: dorsal config pipeline (activate / deactivate / remove) [OPTIONS] TARGET
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * target TEXT The index or name of the model to (activate / deactivate / remove). [required] │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
🎉 You've Completed the CLI Guide!
Congratulations! You have now reviewed the documentation for all command groups in the Dorsal CLI.
You've covered everything from authentication, analyzing local files and directories, managing remote records and collections, and handling local configuration and cache maintenance.
What next?
-
🐍 Learn the Python API
Not everything can be done in the CLI. Learn how to build your own custom annotation models, use dorsal for analysis, and integrate dorsal into your workflows and projects.
-
🖥️ Explore DorsalHub
Get oriented with the DorsalHub website. View and organize your indexed files from your dashboard.