Skip to content

Command line

Output of jscycles --help:

Usage: jscycles [OPTIONS] [paths]...
Arguments:
[paths]... Paths to check (if empty, uses config scan paths)
Options:
--only <only> Only check packages matching glob pattern (can be repeated)
--exclude <exclude> Exclude packages matching glob pattern (can be repeated)
--extensions <extensions> File extensions to analyze [default: ts,tsx,mts,cts,js,jsx,mjs,cjs]
--tsconfig <tsconfig> Path to tsconfig.json
--no-tsconfig Skip tsconfig.json auto-detection
--skip-type-imports Ignore type-only imports (import type, export type, declaration files)
--json Output as JSON
--stdin Read paths from stdin
-c, --config <config> Path to config file [default: jscycles.yaml]
-q, --quiet Only output if cycles found
--inner Show only file-level (inner) cycles
--outer Show only package-level (outer) cycles
-v, --verbose Show all packages (including clean) and file-level details
-h, --help Print help
-V, --version Print version
Status Meaning
0 The scan completed and found no cycle.
1 The scan completed and found at least one cycle.
2 The scan could not complete: bad configuration, an unreadable file, a syntax error, or a resource limit. A failed scan never reports clean.

Options that also exist in jscycles.yaml take precedence over it; see configuration.