@shifter/cli

The Shifter Command Line Interface (CLI) allows you to create, develop, and deploy modern WordPress sites from the terminal.

• Usage
• Commands

Usage

$ npm install -g @shifter/cli
$ shifter COMMAND
running command...
$ shifter (-v|--version|version)
@shifter/cli/0.1.2 darwin-x64 node-v14.16.1
$ shifter --help [COMMAND]
USAGE
  $ shifter COMMAND
...

Commands

• shifter artifacts:build
• shifter artifacts:list
• shifter artifacts:status
• shifter domain:add
• shifter domain:attach
• shifter domain:delete
• shifter domain:detach
• shifter domain:get
• shifter domain:get-verification-code
• shifter domain:list
• shifter help [COMMAND]
• shifter sites:create
• shifter sites:delete
• shifter sites:describe
• shifter sites:list
• shifter sites:start

shifter artifacts:build

Artifacts build command

USAGE
  $ shifter artifacts:build

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter artifacts:build --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

See code: src/commands/artifacts/build.ts

shifter artifacts:list

Artifacts list command

USAGE
  $ shifter artifacts:list

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter artifacts:list --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

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

shifter artifacts:status

Artifacts status command

USAGE
  $ shifter artifacts:status

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter artifacts:status --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

See code: src/commands/artifacts/status.ts

shifter domain:add

Domain registration command

USAGE
  $ shifter domain:add

OPTIONS
  -D, --domain=domain      target domain name (eg. example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:add --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx --domain test.example.com

See code: src/commands/domain/add.ts

shifter domain:attach

Domain attach command

USAGE
  $ shifter domain:attach

OPTIONS
  -D, --domain=domain      Target domain name (eg. www.example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --no-shifter-cdn         If you using another CDN like Netlify or own CloudFront etc... Please set the flag.
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:attach --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx  --domain test.example.com

    Use own CDN (Netlify or own CloudFront etc...)
  $ shifter domain:attach --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx  --domain test.example.com 
  --no-shifter-cdn

See code: src/commands/domain/attach.ts

shifter domain:delete

Domain delete command

USAGE
  $ shifter domain:delete

OPTIONS
  -D, --domain=domain      Target domain name (eg. www.example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:delete --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx  --domain 
  test.example.com

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

shifter domain:detach

Domain detach command

USAGE
  $ shifter domain:detach

OPTIONS
  -D, --domain=domain      Target domain name (eg. www.example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --no-shifter-cdn         If you using another CDN like Netlify or own CloudFront etc... Please set the flag.
  --verbose                Show verbose

EXAMPLE
  $ shifter domain:detach --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx  --domain 
  test.example.com

See code: src/commands/domain/detach.ts

shifter domain:get

Domain get command

USAGE
  $ shifter domain:get

OPTIONS
  -D, --domain=domain      target domain name (eg. example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:get --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx --domain test.example.com

See code: src/commands/domain/get.ts

shifter domain:get-verification-code

Domain verification code command

USAGE
  $ shifter domain:get-verification-code

OPTIONS
  -D, --domain=domain      target domain name (eg. example.com)
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:get-verification-code --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx 
  --domain test.example.com

See code: src/commands/domain/get-verification-code.ts

shifter domain:list

Domain lists command

USAGE
  $ shifter domain:list

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter domain:list --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

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

shifter help [COMMAND]

display help for shifter

USAGE
  $ shifter help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

shifter sites:create

Create a new site

USAGE
  $ shifter sites:create

OPTIONS
  -S, --site-name=site-name  Shifter site name
  -U, --username=username    Shifter username
  -h, --help                 show CLI help
  -v, --version              show CLI version
  --development              Work as development mode (Only for Shifter developer team)
  --plan-id=plan-id          Shifter plan id
  --verbose                  Show verbose

EXAMPLES
  Simple usage
  $ shifter sites:create --username USERNAME --password PASSWORD --site-name "Name of site"

See code: src/commands/sites/create.ts

shifter sites:delete

Sites delete command

USAGE
  $ shifter sites:delete

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter sites:delete --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

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

shifter sites:describe

Sites describe command

USAGE
  $ shifter sites:describe

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter sites:describe --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

See code: src/commands/sites/describe.ts

shifter sites:list

Sites lists command

USAGE
  $ shifter sites:list

OPTIONS
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

EXAMPLES
  Simple usage
  $ shifter sites:list --username USERNAME --password PASSWORD

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

shifter sites:start

describe the command here

USAGE
  $ shifter sites:start --username USERNAME --password PASSWORD --site-id xxx-YOUR-SITE-ID-xxxx

OPTIONS
  -S, --site-id=site-id    Shifter site id
  -U, --username=username  Shifter username
  -h, --help               show CLI help
  -v, --version            show CLI version
  --development            Work as development mode (Only for Shifter developer team)
  --verbose                Show verbose

See code: src/commands/sites/start.ts