Skip to main content

Module cli

Module cli 

Source
Expand description

Command-line interface definitions.

Contains argument structures and command handlers for the Scope CLI. This module is exposed for use by the web server crate.

§CLI Module

This module defines the command-line interface using clap with derive macros. It provides the main Cli struct and Commands enum that define all available commands and their arguments.

§UX Features

  • Progress indicators — Spinners and step counters via the progress module
  • Help with examples — after_help blocks with example invocations
  • Command grouping — Commands ordered by task (entity lookup, token analysis, compliance, data/export, config)
  • Shell completion — scope completions bash|zsh|fish via clap_complete
  • Typo suggestions — Built-in clap fuzzy matching for misspelled commands

§Command Structure

scope [OPTIONS] <COMMAND>

Entity lookup:
  address      Analyze a blockchain address (alias: addr)
  tx           Analyze a transaction (alias: transaction)
  contract     Analyze a smart contract (alias: ct)
  insights     Auto-detect target type and run analyses (alias: insight)

Token analysis:
  crawl        Crawl a token for DEX analytics (alias: token)
  token-health DEX analytics + optional order book (alias: health)
  discover     Browse trending/boosted tokens (alias: disc)
  monitor      Live TUI dashboard (alias: mon)
  market       Peg and order book health for stablecoins
  venues       Manage exchange venue descriptors (alias: ven)

Compliance:
  compliance   Risk, trace, analyze, compliance-report

Data & export:
  address-book Add, remove, list, summary (alias: ab, portfolio)
  export       Export to JSON/CSV
  report       Batch and combined reports

Config & interactive:
  interactive  Full-screen TUI for every command (alias: tui, shell)
  setup        Configure API keys and preferences (alias: config)
  completions  Generate shell completions for bash/zsh/fish

Options:
  --config <PATH>   Path to configuration file
  -v, --verbose...  Increase logging verbosity
  --ai              Markdown output for agent parsing
  --no-color        Disable colored output
  -h, --help        Print help (with examples)
  -V, --version     Print version

Re-exports§

pub use address::AddressArgs;
pub use address_book::AddressBookArgs;
pub use crawl::CrawlArgs;
pub use export::ExportArgs;
pub use interactive::InteractiveArgs;
pub use monitor::MonitorArgs;
pub use setup::SetupArgs;
pub use tx::TxArgs;

Modules§

address
Address Analysis Command
address_book
Address Book Command
address_report
Address Report Generator
candles
The candlestick chart of market ohlc (mockup approved 2026-10-26).
charts
The one chart component of the TUI and the monitor (#58).
compliance
CLI commands for compliance and risk analysis
contract
Contract Analysis Command
crawl
Crawl Command
discover
Discover Command
dispatch
Command Dispatch
errors
Error display and remediation hints for CLI output.
export
Export Command
ghola_offer
Ghola install offer
health_args
Shared order book health threshold flags.
insights
Insights Command
interactive
Interactive Mode
market
Market Command
monitor
Live Token Monitor
output
Command Output
progress
Progress Indicators
prompt
Prompt input
repeat
The one repeat runner for commands that take --every and --duration (#58).
report
Report Command
resolve
One resolver for every command that takes a token symbol (docs/design/2026-10-15-token-disambiguation-design.md).
setup
Setup Command
theme
The ratatui adapter of the theme (scope::display::theme).
token_health
Token Health Command
tui
Unified TUI
tx
Transaction Analysis Command
venues
scope venues subcommands for managing venue descriptors.
watch
Watchlist runs (#47)

Structs§

Cli
Blockchain Analysis CLI - A tool for blockchain data analysis.
CompletionsArgs
Arguments for the completions command.
WebArgs
Arguments for the web server command.

Enums§

Commands
Available CLI subcommands.