Skip to content

CLI flow

importscope is organized around six top-level commands:

  1. check to validate the setup
  2. init to create or inspect config file
  3. config to edit common config fields without hand-editing YAML
  4. profiles to inspect available output bundles
  5. analyze to generate graphs and other artifacts
  6. inspect to query specific results (e.g. a problematic import edge)

Default Workflow

If you are standing in the target repo root, the shortest useful workflow is:

importscope check
importscope init
importscope config exclude add 'tests/**'
importscope analyze
importscope inspect path mypackage.api mypackage.core --highlight

Those commands rely on the built-in defaults:

  • repo: current directory
  • config: auto-discovered .importscope.yml when present
  • analyze output: .cache/importscope
  • inspect snapshot: .cache/importscope/analysis_snapshot.json

Only add flags when you need to override that default flow.