Nanananananananana.. Pat Man!
    Wondering what’s next for npm?Check out our public roadmap! »

    @saltcorn/cli

    0.4.4-beta.1 • Public • Published

    @saltcorn/cli

    Saltcorn command line interface

    oclif Version License

    Usage

    $ npm install -g @saltcorn/cli
    $ saltcorn COMMAND
    running command...
    $ saltcorn (-v|--version|version)
    @saltcorn/cli/0.4.4-beta.1 darwin-x64 node-v15.11.0
    $ saltcorn --help [COMMAND]
    USAGE
      $ saltcorn COMMAND
    ...

    Commands

    saltcorn add-schema

    Add Saltcorn schema to existing database

    USAGE
      $ saltcorn add-schema
    

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

    saltcorn backup

    Backup the PostgreSQL database to a file with pg_dump or zip

    USAGE
      $ saltcorn backup
    
    OPTIONS
      -o, --output=output  output filename
      -t, --tenant=tenant  tenant
      -z, --zip            zip format
    

    See code: src/commands/backup.js

    saltcorn create-tenant TENANT

    Create a tenant

    USAGE
      $ saltcorn create-tenant TENANT
    
    ARGUMENTS
      TENANT  Tenant subdomain to create
    

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

    saltcorn create-user

    Create a new user

    USAGE
      $ saltcorn create-user
    
    OPTIONS
      -a, --admin              Admin user
      -e, --email=email        email
      -p, --password=password  password
      -r, --role=role          role
      -t, --tenant=tenant      tenant
    

    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 info

    Show paths

    USAGE
      $ saltcorn info
    
    OPTIONS
      -j, --json  json format
    
    DESCRIPTION
      ...
      Show configuration and file store paths
    
    ALIASES
      $ saltcorn paths
    

    See code: src/commands/info.js

    saltcorn install-pack

    Install a pack

    USAGE
      $ saltcorn install-pack
    
    OPTIONS
      -f, --file=file      File with pack JSON
      -n, --name=name      Pack name in store
      -t, --tenant=tenant  tenant
    

    See code: src/commands/install-pack.js

    saltcorn install-plugin

    Install a plugin

    USAGE
      $ saltcorn install-plugin
    
    OPTIONS
      -d, --directory=directory  Directory with local plugin
      -n, --name=name            Plugin name in store
      -t, --tenant=tenant        tenant
    

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

    saltcorn list-tenants

    List tenants in CSV format

    USAGE
      $ saltcorn list-tenants
    

    See code: src/commands/list-tenants.js

    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 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
      -t, --tenant=tenant  tenant
    
    DESCRIPTION
      ...
      This will delete all existing information
    

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

    saltcorn restore FILE

    Restore a previously backed up database (zip or sqlc format)

    USAGE
      $ saltcorn restore FILE
    
    ARGUMENTS
      FILE  backup file to restore
    
    OPTIONS
      -t, --tenant=tenant  tenant
    

    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-benchmark [BASEURL]

    Run benchmark

    USAGE
      $ saltcorn run-benchmark [BASEURL]
    
    ARGUMENTS
      BASEURL  Base URL
    
    OPTIONS
      -d, --delay=delay  [default: 30] delay between runs (s)
      -t, --token=token  API Token for reporting results
    

    See code: src/commands/run-benchmark.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 scheduler

    Run the Saltcorn scheduler

    USAGE
      $ saltcorn scheduler
    
    OPTIONS
      -v, --verbose  Verbose
    

    See code: src/commands/scheduler.js

    saltcorn serve

    Start the Saltcorn server

    USAGE
      $ saltcorn serve
    
    OPTIONS
      -n, --nomigrate    No migrations
      -p, --port=port    [default: 3000] port
      -s, --noscheduler  No scheduler
      -v, --verbose      Verbose
    

    See code: src/commands/serve.js

    saltcorn set-cfg KEY VALUE

    Set a configuration value

    USAGE
      $ saltcorn set-cfg KEY VALUE
    
    ARGUMENTS
      KEY    Configuration key
      VALUE  Configuration value (JSON or string)
    
    OPTIONS
      -p, --plugin=plugin  plugin
      -t, --tenant=tenant  tenant
    

    See code: src/commands/set-cfg.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 setup-benchmark

    Setup an instance for benchmarking

    USAGE
      $ saltcorn setup-benchmark
    
    OPTIONS
      -t, --tenant=tenant  tenant
    

    See code: src/commands/setup-benchmark.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

    saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]

    transform an existing field by applying a calculated expression

    USAGE
      $ saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]
    
    ARGUMENTS
      EXPRESSION  expression to calculate field
      FIELD       field name
      TABLE       table name
      TENANT      tenant name
    

    See code: src/commands/transform-field.js

    Keywords

    Install

    npm i @saltcorn/cli

    DownloadsWeekly Downloads

    236

    Version

    0.4.4-beta.1

    License

    MIT

    Unpacked Size

    66.1 kB

    Total Files

    33

    Homepage

    saltcorn.com

    Last publish

    Collaborators

    • avatar