sourcescape

• Usage
• Commands

Usage

$ npm install -g sourcescape
$ sourcescape COMMAND
running command...
$ sourcescape (--version)
sourcescape/1.1.2 darwin-arm64 node-v16.18.0
$ sourcescape --help [COMMAND]
USAGE
  $ sourcescape COMMAND
...

Commands

• sourcescape clean
• sourcescape delete:indexes REPO
• sourcescape help [COMMANDS]
• sourcescape list:repos
• sourcescape run-index DIRECTORY
• sourcescape start
• sourcescape status
• sourcescape stop

sourcescape clean

Cleans out existing SourceScape containers. Used for upgrading.

USAGE
  $ sourcescape clean [-h] [-d] [-i]

FLAGS
  -d, --data    Wipe datastores.
  -h, --help    Show CLI help.
  -i, --images  Delete images.

DESCRIPTION
  Cleans out existing SourceScape containers. Used for upgrading.

EXAMPLES
  $ sourcescape clean

See code: src/commands/clean.ts

sourcescape delete:indexes REPO

USAGE
  $ sourcescape delete:indexes REPO [-p <value>] [-d]

ARGUMENTS
  REPO  repo to delete

FLAGS
  -d, --debug         use debug mode
  -p, --port=<value>  [default: 5001] Expose this port

See code: src/commands/delete/indexes.ts

sourcescape help [COMMANDS]

Display help for sourcescape.

USAGE
  $ sourcescape help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for sourcescape.

See code: @oclif/plugin-help

sourcescape list:repos

USAGE
  $ sourcescape list:repos [-p <value>] [-d]

FLAGS
  -d, --debug         use debug mode
  -p, --port=<value>  [default: 5001] Expose this port

See code: src/commands/list/repos.ts

sourcescape run-index DIRECTORY

USAGE
  $ sourcescape run-index DIRECTORY [-p <value>] [-d]

ARGUMENTS
  DIRECTORY  directory to index

FLAGS
  -d, --debug         use debug mode
  -p, --port=<value>  [default: 5001] Expose this port

See code: src/commands/run-index.ts

sourcescape start

Initialize SourceScape.

USAGE
  $ sourcescape start [-h] [-f] [-p <value>]

FLAGS
  -f, --force-pull    Force pull images
  -h, --help          Show CLI help.
  -p, --port=<value>  [default: 5001] Expose this port

DESCRIPTION
  Initialize SourceScape.

EXAMPLES
  $ sourcescape start <YOUR_DIRECTORY>

See code: src/commands/start.ts

sourcescape status

Get which containers are running.

USAGE
  $ sourcescape status [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Get which containers are running.

EXAMPLES
  $ sourcescape status

See code: src/commands/status.ts

sourcescape stop

Shuts down running SourceScape containers.

USAGE
  $ sourcescape stop

DESCRIPTION
  Shuts down running SourceScape containers.

EXAMPLES
  $ sourcescape stop

See code: src/commands/stop.ts