❤
npm
Sign UpSign In

hexabase-cli
TypeScript icon, indicating that this package has built-in type declarations

0.3.19 • Public • Published

hexabase-cli

Hexabase CLI

oclif Version Downloads/week License

Requirements

- node.js >= 12.0.0
- npm >= 6.0.0

Usage

$ npm install -g hexabase-cli
$ hx COMMAND
running command...
$ hx (-v|--version|version)
hexabase-cli/0.3.19 linux-x64 node-v16.13.1
$ hx --help [COMMAND]
USAGE
  $ hx COMMAND
...

Commands

hx actions:create DATASTORE_ID

create an action in a datastore

USAGE
  $ hx actions:create DATASTORE_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

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

hx actions:delete DATASTORE_ID ACTION_ID

delete an action in a datastore

USAGE
  $ hx actions:delete DATASTORE_ID ACTION_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  ACTION_ID     action_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -y, --yes              skip confirmation

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

hx actions:get [DATASTORE_ID] [STATUS_ID]

get actions in a datastore

USAGE
  $ hx actions:get [DATASTORE_ID] [STATUS_ID]

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  STATUS_ID     status_id of the status action

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx ac

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

hx actions:scripts:download ACTION_ID

download actionscript file

USAGE
  $ hx actions:scripts:download ACTION_ID

ARGUMENTS
  ACTION_ID  action_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -o, --output=output    output file
  -t, --type=post|pre    (required) script type

ALIASES
  $ hx scripts:download
  $ hx as:get
  $ hx as

See code: src/commands/actions/scripts/download.ts

hx actions:scripts:download_all [PROJECT_ID]

download all actionscript file

USAGE
  $ hx actions:scripts:download_all [PROJECT_ID]

ARGUMENTS
  PROJECT_ID  Project_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -o, --output=output    output folder

ALIASES
  $ hx scripts:download-all
  $ hx as:getall
  $ hx asall

See code: src/commands/actions/scripts/download_all.ts

hx actions:scripts:upload ACTION_ID FILE

upload actionscript file

USAGE
  $ hx actions:scripts:upload ACTION_ID FILE

ARGUMENTS
  ACTION_ID  action_id from hexabase
  FILE       file to be uploaded, e.g. script.js

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -t, --type=post|pre    (required) script type
  -y, --yes              skip confirmation

ALIASES
  $ hx scripts:upload
  $ hx as:put

See code: src/commands/actions/scripts/upload.ts

hx actions:show DATASTORE_ID ACTION_ID

show details of an action

USAGE
  $ hx actions:show DATASTORE_ID ACTION_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  ACTION_ID     action_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

See code: src/commands/actions/show.ts

hx actions:update DATASTORE_ID ACTION_ID

update an action in a datastore

USAGE
  $ hx actions:update DATASTORE_ID ACTION_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  ACTION_ID     action_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

See code: src/commands/actions/update.ts

hx apps:create

download & create new app from a template

USAGE
  $ hx apps:create

OPTIONS
  -h, --help       show CLI help
  -n, --name=name  name of your app

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

hx apps:init

initialize app with hexabase settings

USAGE
  $ hx apps:init

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -f, --file=file        [default: hx-settings.json] hexabase settings file
  -h, --help             show CLI help

ALIASES
  $ hx init

See code: src/commands/apps/init.ts

hx autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ hx autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

hx contexts:delete [CONTEXT]

delete context entries

USAGE
  $ hx contexts:delete [CONTEXT]

ARGUMENTS
  CONTEXT  context name

OPTIONS
  -h, --help  show CLI help

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

hx contexts:get

get contexts

USAGE
  $ hx contexts:get

OPTIONS
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx env

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

hx contexts:login

login to hexabase within current context

USAGE
  $ hx contexts:login

OPTIONS
  -c, --context=context    use provided context instead of currently set context
  -h, --help               show CLI help
  -p, --password=password  login password
  -u, --email=email        user email address to login

ALIASES
  $ hx login

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

hx contexts:set CONTEXT

set context entries (server & sse)

USAGE
  $ hx contexts:set CONTEXT

ARGUMENTS
  CONTEXT  context name

OPTIONS
  -h, --help       show CLI help
  --server=server  API server, e.g. https://api.hexabase.com
  --sse=sse        SSE server, e.g. https://sse.hexabase.com

See code: src/commands/contexts/set.ts

hx contexts:use [CONTEXT]

set current-context

USAGE
  $ hx contexts:use [CONTEXT]

ARGUMENTS
  CONTEXT  context name

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ hx use

See code: src/commands/contexts/use.ts

hx datastores:get [PROJECT_ID]

get datastores within a project

USAGE
  $ hx datastores:get [PROJECT_ID]

ARGUMENTS
  PROJECT_ID  project_id from hexabase

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx ds
  $ hx datastores

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

hx fields:create DATASTORE_ID

create a field in a datastore

USAGE
  $ hx fields:create DATASTORE_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

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

hx fields:delete DATASTORE_ID FIELD_ID

delete a field in a datastore

USAGE
  $ hx fields:delete DATASTORE_ID FIELD_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  FIELD_ID      field_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -y, --yes              skip confirmation

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

hx fields:get [DATASTORE_ID]

get fields in a datastore

USAGE
  $ hx fields:get [DATASTORE_ID]

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx fd
  $ hx fields

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

hx fields:show DATASTORE_ID FIELD_ID

show details of a field

USAGE
  $ hx fields:show DATASTORE_ID FIELD_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  FIELD_ID      field_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

See code: src/commands/fields/show.ts

hx fields:update DATASTORE_ID FIELD_ID

update a field in a datastore

USAGE
  $ hx fields:update DATASTORE_ID FIELD_ID

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase
  FIELD_ID      field_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

See code: src/commands/fields/update.ts

hx help [COMMAND]

display help for hx

USAGE
  $ hx help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

hx logs:actionscript CHANNEL

get logs from actionscript

USAGE
  $ hx logs:actionscript CHANNEL

ARGUMENTS
  CHANNEL  input format: logs_<user_id>_<project_id>

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

See code: src/commands/logs/actionscript.ts

hx projects:backup [TEMPLATE_ID]

download template file

USAGE
  $ hx projects:backup [TEMPLATE_ID]

ARGUMENTS
  TEMPLATE_ID  template_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -o, --output=output    output file

ALIASES
  $ hx pj:backup

See code: src/commands/projects/backup.ts

hx projects:create

create new project within current workspace

USAGE
  $ hx projects:create

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

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

hx projects:get

get projects in current workspace

USAGE
  $ hx projects:get

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx pj
  $ hx projects

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

hx projects:restore FILE

restore a project from a template file

USAGE
  $ hx projects:restore FILE

ARGUMENTS
  FILE  zip file to be restored from, e.g. template.zip

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -n, --name=name        name of the project to be restored
  -y, --yes              skip confirmation

ALIASES
  $ hx pj:restore

See code: src/commands/projects/restore.ts

hx projects:roles:get PROJECT_ID

get roles of a project

USAGE
  $ hx projects:roles:get PROJECT_ID

ARGUMENTS
  PROJECT_ID  project_id from hexabase

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: src/commands/projects/roles/get.ts

hx projects:save [PROJECT_ID]

save template from a project

USAGE
  $ hx projects:save [PROJECT_ID]

ARGUMENTS
  PROJECT_ID  project_id from hexabase

OPTIONS
  -c, --context=context    use provided context instead of currently set context
  -d, --download=download  download output file (e.g. my_template.zip)
  -h, --help               show CLI help

ALIASES
  $ hx pj:save

See code: src/commands/projects/save.ts

hx projects:settings:download [ID]

download settingdownload setting application, datastore, action with ID parameter

USAGE
  $ hx projects:settings:download [ID]

ARGUMENTS
  ID  project_id if -t=application and datastore_id if -t=datastore||action  from hexabase

OPTIONS
  -c, --context=context                    use provided context instead of currently set context
  -h, --help                               show CLI help
  -o, --output=output                      output folder

  -t, --type=application|datastore|action  (required) type download setting is one of the following options:
                                           [application, datastore, action]

ALIASES
  $ hx pj:settings:get

See code: src/commands/projects/settings/download.ts

hx projects:settings:download_all

download all settings of the project in the current workspace

USAGE
  $ hx projects:settings:download_all

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help
  -o, --output=output    output folder

ALIASES
  $ hx pj:settings:getall

See code: src/commands/projects/settings/download_all.ts

hx statuses:get [DATASTORE_ID]

get statuses in a datastore

USAGE
  $ hx statuses:get [DATASTORE_ID]

ARGUMENTS
  DATASTORE_ID  datastore_id from hexabase

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx st
  $ hx status

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

hx workspaces:get

get workspaces from hexabase

USAGE
  $ hx workspaces:get

OPTIONS
  -c, --context=context   use provided context instead of currently set context
  -h, --help              show CLI help
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

ALIASES
  $ hx ws
  $ hx workspaces

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

hx workspaces:use [WORKSPACE_ID]

set current workspace in hexabase

USAGE
  $ hx workspaces:use [WORKSPACE_ID]

ARGUMENTS
  WORKSPACE_ID  workspace_id from hexabase

OPTIONS
  -c, --context=context  use provided context instead of currently set context
  -h, --help             show CLI help

ALIASES
  $ hx select
  $ hx sel

See code: src/commands/workspaces/use.ts

Readme

Keywords

Package Sidebar

Install

npm i hexabase-cli

Repository

github.com/hexabase/hexabase-cli

Homepage

github.com/hexabase/hexabase-cli

Weekly Downloads

30

Version

0.3.19

License

MIT

Unpacked Size

679 kB

Total Files

109

Last publish

Collaborators

  • beee-devops
Try on RunKit
Report malware