@saltcorn/cli

Saltcorn command line interface

• @saltcorn/cli
• Usage
• Commands

Usage

$ npm install -g @saltcorn/cli
$ saltcorn COMMAND
running command...
$ saltcorn (-v|--version|version)
@saltcorn/cli/0.2.3-beta.2 linux-x64 node-v14.4.0
$ saltcorn --help [COMMAND]
USAGE
  $ saltcorn COMMAND
...

Commands

• saltcorn backup
• saltcorn create-user
• saltcorn fixtures
• saltcorn help [COMMAND]
• saltcorn localize-plugin PLUGIN PATH
• saltcorn make-migration
• saltcorn migrate
• saltcorn paths
• saltcorn plugins
• saltcorn reset-schema
• saltcorn restore FILE
• saltcorn rm-tenant TENANT
• saltcorn run-tests [PACKAGE]
• saltcorn serve
• saltcorn setup
• saltcorn test-plugin PATH

saltcorn backup

Backup the database to a file

USAGE
  $ saltcorn backup

OPTIONS
  -o, --output=output  [default: 20201023-saltcorn-LAPTOP-3VET16LK.sqlc] output filename

See code: src/commands/backup.js

saltcorn create-user

Create a new user

USAGE
  $ saltcorn create-user

OPTIONS
  -a, --admin  Admin user

See code: src/commands/create-user.js

saltcorn fixtures

Load fixtures for testing

USAGE
  $ saltcorn fixtures

OPTIONS
  -r, --reset  Also reset schema

DESCRIPTION
  ...
  This manual step it is never required for users and rarely required for developers

See code: src/commands/fixtures.js

saltcorn help [COMMAND]

display help for saltcorn

USAGE
  $ saltcorn help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

saltcorn localize-plugin PLUGIN PATH

Convert npm to local plugin

USAGE
  $ saltcorn localize-plugin PLUGIN PATH

ARGUMENTS
  PLUGIN  Current (npm) plugin name
  PATH    path to local plugin

See code: src/commands/localize-plugin.js

saltcorn make-migration

Create a new blank migration file

USAGE
  $ saltcorn make-migration

DESCRIPTION
  ...
  These migrations track internal structures to the database. You should not
  normally need to run this unless you are a developer.

See code: src/commands/make-migration.js

saltcorn migrate

Run migrations

USAGE
  $ saltcorn migrate

DESCRIPTION
  ...
  This is not normally required as migrations will be run when the server starts. 
  However, this command may be useful if you are running multiple application 
  servers and need to control when the migrations are run.

See code: src/commands/migrate.js

saltcorn paths

Show paths

USAGE
  $ saltcorn paths

DESCRIPTION
  ...
  Show configuration and file store paths

See code: src/commands/paths.js

saltcorn plugins

List and upgrade plugins for tenants

USAGE
  $ saltcorn plugins

OPTIONS
  -d, --dryRun   Upgrade dry-run
  -u, --upgrade  Upgrade

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/plugins.js

saltcorn reset-schema

Reset the database

USAGE
  $ saltcorn reset-schema

OPTIONS
  -f, --force  force

DESCRIPTION
  ...
  This will delete all existing information

See code: src/commands/reset-schema.js

saltcorn restore FILE

Restore a previously backed up database from a file

USAGE
  $ saltcorn restore FILE

ARGUMENTS
  FILE  backup file to restore

See code: src/commands/restore.js

saltcorn rm-tenant TENANT

Remove a tenant

USAGE
  $ saltcorn rm-tenant TENANT

ARGUMENTS
  TENANT  Tenant to remove

See code: src/commands/rm-tenant.js

saltcorn run-tests [PACKAGE]

Run test suites

USAGE
  $ saltcorn run-tests [PACKAGE]

ARGUMENTS
  PACKAGE  which package to run tests for

OPTIONS
  -c, --coverage  Coverage
  -f, --forever   Run forever till failure

See code: src/commands/run-tests.js

saltcorn serve

Start the Saltcorn server

USAGE
  $ saltcorn serve

OPTIONS
  -p, --port=port  [default: 3000] port
  -v, --verbose    Verbose

See code: src/commands/serve.js

saltcorn setup

Set up a new system

USAGE
  $ saltcorn setup

OPTIONS
  -c, --coverage  Coverage

DESCRIPTION
  ...
  This will attempt to install or connect a database, and set up a 
  configuration file

See code: src/commands/setup.js

saltcorn test-plugin PATH

Test a plugin

USAGE
  $ saltcorn test-plugin PATH

ARGUMENTS
  PATH  path to plugin package

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/test-plugin.js