Elastictable CLI

Installation

Install or update the [Elastictable CLI] from npm (requires Node.js ≥ 10.13.0). Only Active LTS Node versions are supported.

$ npm i -g @elastictable/cli

• Elastictable CLI
• Usage
• Commands

Usage

$ npm install -g @elastictable/cli
$ elastictable COMMAND
running command...
$ elastictable (-v|--version|version)
@elastictable/cli/1.2.2 linux-x64 node-v12.20.0
$ elastictable --help [COMMAND]
USAGE
  $ elastictable COMMAND
...

Commands

• elastictable auth:login [EMAIL] [PASSWORD]
• elastictable auth:logout
• elastictable auth:signup EMAIL [PASSWORD]
• elastictable autocomplete [SHELL]
• elastictable help [COMMAND]
• elastictable table:column:create TABLENAME NAME
• elastictable table:column:list TABLENAME
• elastictable table:create NAME [PLURALNAME]
• elastictable table:list
• elastictable update [CHANNEL]
• elastictable workspace:create NAME
• elastictable workspace:get-deployment-status
• elastictable workspace:get-schema
• elastictable workspace:get-urls STAGE
• elastictable workspace:list
• elastictable workspace:push

elastictable auth:login [EMAIL] [PASSWORD]

Login to access your account

USAGE
  $ elastictable auth:login [EMAIL] [PASSWORD]

ARGUMENTS
  EMAIL     The email address you signed up with
  PASSWORD  The password you signed up with

OPTIONS
  -h, --help  show CLI help

See code: src/src/commands/auth/login.ts

elastictable auth:logout

Log this device out from your account

USAGE
  $ elastictable auth:logout

OPTIONS
  -h, --help  show CLI help

See code: src/src/commands/auth/logout.ts

elastictable auth:signup EMAIL [PASSWORD]

Signup to create an account

USAGE
  $ elastictable auth:signup EMAIL [PASSWORD]

ARGUMENTS
  EMAIL     The email address that you want to sign up with
  PASSWORD  The password that you want to signed up (min 10 chars)

OPTIONS
  -h, --help  show CLI help

See code: src/src/commands/auth/signup.ts

elastictable autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ elastictable autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ elastictable autocomplete
  $ elastictable autocomplete bash
  $ elastictable autocomplete zsh
  $ elastictable autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

elastictable help [COMMAND]

display help for elastictable

USAGE
  $ elastictable help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

elastictable table:column:create TABLENAME NAME

Add a new column to a table

USAGE
  $ elastictable table:column:create TABLENAME NAME

ARGUMENTS
  TABLENAME  The name of table you want to add the new column to
  NAME       The name of the new column

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

ALIASES
  $ elastictable table:columns:create

See code: src/src/commands/table/column/create.ts

elastictable table:column:list TABLENAME

List columns of a table

USAGE
  $ elastictable table:column:list TABLENAME

ARGUMENTS
  TABLENAME  The name of table you want to list the columns of

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

ALIASES
  $ elastictable table:columns:list

See code: src/src/commands/table/column/list.ts

elastictable table:create NAME [PLURALNAME]

Add a new table to a workspace

USAGE
  $ elastictable table:create NAME [PLURALNAME]

ARGUMENTS
  NAME        The name you want for the new table (e.g. project)
  PLURALNAME  The plural name you want for the new table (e.g. projects)

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

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

elastictable table:list

describe the command here

USAGE
  $ elastictable table:list

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

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

elastictable update [CHANNEL]

update the elastictable CLI

USAGE
  $ elastictable update [CHANNEL]

See code: @oclif/plugin-update

elastictable workspace:create NAME

Create a new workspace

USAGE
  $ elastictable workspace:create NAME

ARGUMENTS
  NAME  The name you want for the new workspace

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

elastictable workspace:get-deployment-status

Details about a workspace

USAGE
  $ elastictable workspace:get-deployment-status

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

See code: src/src/commands/workspace/get-deployment-status.ts

elastictable workspace:get-schema

Details about a workspace

USAGE
  $ elastictable workspace:get-schema

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

See code: src/src/commands/workspace/get-schema.ts

elastictable workspace:get-urls STAGE

Details about a workspace

USAGE
  $ elastictable workspace:get-urls STAGE

ARGUMENTS
  STAGE  [default: production] The stage name you want to get the urls for (development or production)

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

ALIASES
  $ elastictable workspace:get-url

See code: src/src/commands/workspace/get-urls.ts

elastictable workspace:list

List your workspaces

USAGE
  $ elastictable workspace:list

OPTIONS
  -e, --extended

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

elastictable workspace:push

Push the mutations in a workspace to the cloud

USAGE
  $ elastictable workspace:push

OPTIONS
  -w, --workspace=workspace  The `name` or `id` of the workspace

See code: src/src/commands/workspace/push.ts