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 primarily used by the binary crate but is exposed for programmatic CLI invocation. It provides the main Cli struct and Commands enum that define all available commands.

§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 examplesafter_help blocks with example invocations
  • Command grouping — Commands ordered by task (entity lookup, token analysis, compliance, data/export, config)
  • Shell completionscope 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)
  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  REPL with preserved context (alias: 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
compliance
CLI commands for compliance and risk analysis
crawl
Crawl Command
discover
Discover Command
errors
Error display and remediation hints for CLI output.
export
Export Command
insights
Insights Command
interactive
Interactive Mode
market
Market Command
monitor
Live Token Monitor
progress
Progress Indicators
report
Report Command
setup
Setup Command
token_health
Token Health Command
tx
Transaction Analysis Command
venues
scope venues subcommands for managing venue descriptors.

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.