Skip to content

Latest commit

 

History

History
145 lines (107 loc) · 4 KB

CLI.md

File metadata and controls

145 lines (107 loc) · 4 KB
Raw

SCIP CLI Reference

NAME:
   scip - SCIP Code Intelligence Protocol CLI

USAGE:
   scip [global options] command [command options] [arguments...]

VERSION:
   v0.5.1

DESCRIPTION:
   For more details, see the project README at:

     https://github.com/sourcegraph/scip

COMMANDS:
   lint      Flag potential issues with a SCIP index
   print     Print a SCIP index for debugging
   snapshot  Generate snapshot files for golden testing
   stats     Output useful statistics about a SCIP index
   test      Validate a SCIP index against test files
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

scip lint

NAME:
   scip lint - Flag potential issues with a SCIP index

USAGE:
   scip lint [command options] [arguments...]

DESCRIPTION:
   Example usage:

     scip lint /path/to/index.scip

   You may want to filter the output using `grep -v <pattern>`
   to narrow down on certain classes of errors.

scip print

NAME:
   scip print - Print a SCIP index for debugging

USAGE:
   scip print [command options] [arguments...]

DESCRIPTION:
   WARNING: The TTY output may change over time.
   Do not rely on non-JSON output in scripts

OPTIONS:
   --json      Output in JSON format (default: false)
   --color     Enable color output for TTY (no effect for JSON) (default: true)
   --help, -h  show help

scip snapshot

NAME:
   scip snapshot - Generate snapshot files for golden testing

USAGE:
   scip snapshot [command options] [arguments...]

DESCRIPTION:
   The snapshot subcommand generates snapshot files which
   can be use for inspecting the output of an index in a
   visual way. Occurrences are marked with caret signs (^)
   and symbol information.

   For testing a SCIP indexer, you can either use this subcommand
   along with 'git diff' or equivalent, or you can use the dedicated
   'test' subcommand for more targeted checks.

OPTIONS:
   --from value            Path to SCIP index file (default: "index.scip")
   --to value              Path to output directory for snapshot files (default: "scip-snapshot")
   --project-root value    Override project root in the SCIP file. For example, this can be helpful when the SCIP index was created inside a Docker image or created on another computer
   --strict                If true, fail fast on errors (default: true)
   --comment-syntax value  Comment syntax to use for snapshot files (default: "//")

scip test

NAME:
   scip test - Validate a SCIP index against test files

USAGE:
   scip test [command options] [arguments...]

DESCRIPTION:
   Validates whether the SCIP data as
   in a given SCIP index matches that specified in human-readable test files,
   using syntax similar to the 'snapshot subcommand'. Test file syntax reference:

       https://github.com/sourcegraph/scip/blob/v0.5.1/docs/test_file_format.md

   The test files are located based on the relative_path field
   in the SCIP document, interpreted relative to the the directory
   the CLI is invoked in.

   If you want to instead check all the data in a SCIP index,
   use the 'snapshot' subcommand.

OPTIONS:
   --from value                                           Path to SCIP index file (default: "index.scip")
   --comment-syntax value                                 Comment syntax to use for snapshot files (default: "//")
   --filter value, -f value [ --filter value, -f value ]  Explicit list of test files to check. Can be specified multiple times. If not specified, all files are tested.
   --help, -h                                             show help

scip stats

NAME:
   scip stats - Output useful statistics about a SCIP index

USAGE:
   scip stats [command options] [arguments...]

OPTIONS:
   --from value  Path to SCIP index file (default: index.scip)