@bearer/cli

Bearer CLI

• @bearer/cli
• Usage
• Commands

Usage

$ npm install -g @bearer/cli
$ bearer COMMAND
running command...
$ bearer (-v|--version|version)
@bearer/cli/1.13.9 darwin-x64 node-v10.15.3
$ bearer --help [COMMAND]
USAGE
  $ bearer COMMAND
...

Commands

• bearer autocomplete [SHELL]
• bearer generate
• bearer generate:component [NAME]
• bearer generate:function [NAME]
• bearer help [COMMAND]
• bearer integrations
• bearer integrations:create
• bearer invoke FUNCTION_NAME
• bearer link [INTEGRATION_IDENTIFIER]
• bearer login
• bearer new [INTEGRATIONNAME]
• bearer push
• bearer setup:auth [CREDENTIALS]
• bearer start

bearer autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ bearer autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

bearer generate

generate function

USAGE
  $ bearer generate

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

ALIASES
  $ bearer g

See code: src/commands/generate/index.ts

bearer generate:component [NAME]

Generate a Bearer component

USAGE
  $ bearer generate:component [NAME]

OPTIONS
  -h, --help                        show CLI help
  -t, --type=blank|collection|root
  --path=path
  --silent

ALIASES
  $ bearer g:c

See code: src/commands/generate/component.ts

bearer generate:function [NAME]

Generate a Bearer Function

USAGE
  $ bearer generate:function [NAME]

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

ALIASES
  $ bearer g:f

See code: src/commands/generate/function.ts

bearer help [COMMAND]

display help for bearer

USAGE
  $ bearer help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bearer integrations

list deployed integrations

USAGE
  $ bearer integrations

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

See code: src/commands/integrations/index.ts

bearer integrations:create

create a new Integration

USAGE
  $ bearer integrations:create

OPTIONS
  -d, --description=description
  -h, --help                     show CLI help
  -l, --skipLink
  -n, --name=name
  --path=path
  --silent

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

bearer invoke FUNCTION_NAME

invoke function locally

USAGE
  $ bearer invoke FUNCTION_NAME

OPTIONS
  -d, --data=data
  -f, --file=file
  -h, --help       show CLI help
  --path=path
  --silent

See code: src/commands/invoke.ts

bearer link [INTEGRATION_IDENTIFIER]

link to remote Bearer integration

USAGE
  $ bearer link [INTEGRATION_IDENTIFIER]

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

See code: src/commands/link.ts

bearer login

login using Bearer credentials

USAGE
  $ bearer login

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

See code: src/commands/login.ts

bearer new [INTEGRATIONNAME]

generate integration boilerplate

USAGE
  $ bearer new [INTEGRATIONNAME]

OPTIONS
  -a, --authType=OAUTH1|OAUTH2|BASIC|APIKEY|NONE|CUSTOM  Authorization type
  -d, --directory=directory                              Select a directory as source of the integration
  -f, --force                                            Force copying files
  -h, --help                                             show CLI help
  -t, --template=template                                Generate an integration from a template (git url)
  --path=path
  --silent
  --withViews                                            Experimental - generate views

See code: src/commands/new.ts

bearer push

deploy integration to Bearer

USAGE
  $ bearer push

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

See code: src/commands/push.ts

bearer setup:auth [CREDENTIALS]

setup API credentials for local development.

USAGE
  $ bearer setup:auth [CREDENTIALS]

ARGUMENTS
  CREDENTIALS  Provide inline credentials

OPTIONS
  -h, --help   show CLI help
  --path=path
  --silent

DESCRIPTION
  If you would like to bypass the prompt, you can either:
    * pass credentials as argument (see description later)
    * use environment variables
  see examples

EXAMPLES
  With argument
    bearer setup:auth CLIENT_ID:CLIENT_SECRET
    bearer setup:auth CONSUMER_KEY:CONSUMER_SECRET
    bearer setup:auth USERNAME:PASSWORD
    bearer setup:auth APIKEY
  With environment variables
    BEARER_AUTH_CLIENT_ID=CLIENT_ID BEARER_AUTH_CLIENT_SECRET=CLIENT_SECRET bearer setup:auth
    BEARER_AUTH_CONSUMER_KEY=CONSUMER_KEY BEARER_AUTH_CONSUMER_SECRET=CONSUMER_SECRET bearer setup:auth
    BEARER_AUTH_USERNAME=USERNAME BEARER_AUTH_CONSUMER_SECRET=PASSWORD bearer setup:auth
    BEARER_AUTH_APIKEY=APIKEY bearer setup:auth

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

bearer start

start local development environment

USAGE
  $ bearer start

OPTIONS
  -f, --force   Start using random available port
  -h, --help    show CLI help
  --no-install
  --no-open

See code: src/commands/start.ts