❤
npm
Sign UpSign In

@makeropsinc/cli
TypeScript icon, indicating that this package has built-in type declarations

2.2.2 • Public • Published

@makeropsinc/cli

================

MakerOps CLI

oclif Version Downloads/week License

Usage

$ npm install -g @makeropsinc/cli
$ makerops COMMAND
running command...
$ makerops (-v|--version|version)
@makeropsinc/cli/2.2.2 linux-x64 node-v14.21.3
$ makerops --help [COMMAND]
USAGE
  $ makerops COMMAND
...

Commands

makerops add OBJECT

Add a new object (function/workflow/webhook)

USAGE
  $ makerops add OBJECT

OPTIONS
  -c, --config=config            Config file
  -d, --description=description  Description
  -i, --id=id                    Object ID
  -n, --name=name                Display name
  -o, --org=org                  Org ID
  -p, --auto_publish             Auto publish
  -t, --tags=tags                Tags (comma separated)
  --dir=dir                      Directory under base path in which to save the file

EXAMPLES
  $ makerops add function
  add new function
    
  $ makerops add workflow
  add new workflow
    
  $ makerops add webhook
  add new webhook

See code: lib/commands/add.js

makerops add-function

Add new function

USAGE
  $ makerops add-function

OPTIONS
  -c, --config=config            Config file
  -d, --description=description  Description
  -i, --id=id                    Object ID
  -n, --name=name                Display name
  -o, --org=org                  Org ID
  -p, --auto_publish             Auto publish
  -t, --tags=tags                Tags (comma separated)
  --dir=dir                      Directory under base path in which to save the file

EXAMPLES
  $ makerops add-function
  Add new function to this project
    
  $ makerops add-function --name helloWorld --description="Hello World" --tags="comma,separated,tags"
  Add new function to this project with name helloWorld, description "Hello World" and tags "comma", "separated" and 
  "tags"

See code: lib/commands/add-function.js

makerops add-webhook

Add new webhook

USAGE
  $ makerops add-webhook

OPTIONS
  -c, --config=config            Config file
  -d, --description=description  Description
  -i, --id=id                    Object ID
  -n, --name=name                Display name
  -o, --org=org                  Org ID
  --dir=dir                      Directory under base path in which to save the file

EXAMPLES
  $ makerops add-webhook
  Add new webhook to this project
    
  $ makerops add-webhook --id user-signed-up --name="User Signed Up"
  Add new webhook to this project with ID user-signed-up, name "User Signed Up"

See code: lib/commands/add-webhook.js

makerops add-workflow

Add new workflow

USAGE
  $ makerops add-workflow

OPTIONS
  -c, --config=config  Config file
  -i, --id=id          Object ID
  -n, --name=name      Display name
  -o, --org=org        Org ID
  --dir=dir            Directory under base path in which to save the file

EXAMPLES
  $ makerops add-workflow
  Add new workflow to this project
    
  $ makerops add-workflow --id helloWorld --name="Hello World"
  Add new workflow to this project with ID helloWorld, name "Hello World"

See code: lib/commands/add-workflow.js

makerops build [OBJECT] [ID]

Build everything

USAGE
  $ makerops build [OBJECT] [ID]

OPTIONS
  -c, --config=config  Config file
  -n, --noClean        Do not clean up build folder

EXAMPLE
  $ makerops build
  build all functions/workflows/webhooks/etc

See code: lib/commands/build.js

makerops build-functions [FUNCTION]

Build function/s

USAGE
  $ makerops build-functions [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -n, --noClean        Do not clean up build folder

EXAMPLES
  $ makerops build
  build all functions
    
  $ makerops build helloWorld
  build the 'helloWorld' function

See code: lib/commands/build-functions.js

makerops build-workflows [WORKFLOW]

Build workflow/s

USAGE
  $ makerops build-workflows [WORKFLOW]

OPTIONS
  -c, --config=config  Config file
  -n, --noClean        Do not clean up build folder

EXAMPLES
  $ makerops build-workflows
  build all workflows
    
  $ makerops build-workflows helloWorld
  build the 'helloWorld' workflow

See code: lib/commands/build-workflows.js

makerops check [ORG]

Check configuration

USAGE
  $ makerops check [ORG]

EXAMPLE
  $ makerops check [org]
  check cli config (environment variables)

See code: lib/commands/check.js

makerops clean

Clean build cache

USAGE
  $ makerops clean

EXAMPLE
  $ makerops clean
  cleanup build cache

See code: lib/commands/clean.js

makerops config [ORG]

Update authentication config

USAGE
  $ makerops config [ORG]

OPTIONS
  -a, --api_url=api_url            API URL
  -c, --config=config              Config file
  -e, --userEmail=userEmail        User email
  -i, --clientId=clientId          Client ID
  -n, --userName=userName          User name
  -s, --clientSecret=clientSecret  Client secret
  -u, --userId=userId              User ID
  -v, --environment=(dev|prod)     Environment (dev/prod)

EXAMPLE
  $ makerops config myorg --userEmail development@makerops.com
  Set user's email for org myorg

See code: lib/commands/config.js

makerops delete OBJECT ID

Delete an object (function/workflow/webhook)

USAGE
  $ makerops delete OBJECT ID

OPTIONS
  -c, --config=config  Config file
  -k, --keep           Keep local file
  -o, --org=org        Org ID

EXAMPLES
  $ makerops delete function fn001
  delete function 'fn001'
    
  $ makerops delete workflow wf001
  delete workflow 'wf001'
    
  $ makerops delete webhook wh001
  delete webhook 'wh001'

See code: lib/commands/delete.js

makerops delete-function [FUNCTION]

Delete function

USAGE
  $ makerops delete-function [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  -p, --keep           Auto publish

EXAMPLES
  $ makerops delete-function fn39
  Delete function 'fn39'
    
  $ makerops delete-function fn39 --keep
  Delete function 'fn39' keeping the local file.

See code: lib/commands/delete-function.js

makerops delete-webhook [WEBHOOK]

Delete webhook

USAGE
  $ makerops delete-webhook [WEBHOOK]

OPTIONS
  -c, --config=config  Config file
  -k, --keep           Keep local file
  -o, --org=org        Org ID

EXAMPLES
  $ makerops delete-webhook wh001
  Delete webhook 'wh001'
    
  $ makerops delete-webhook wh001 --keep
  Delete webhook 'wh001' keeping the local file.

See code: lib/commands/delete-webhook.js

makerops delete-workflow [WORKFLOW]

Delete workflow

USAGE
  $ makerops delete-workflow [WORKFLOW]

OPTIONS
  -c, --config=config  Config file
  -k, --keep           Keep local file
  -o, --org=org        Org ID

EXAMPLES
  $ makerops delete-workflow wf001
  Delete workflow 'wf001'
    
  $ makerops delete-workflow wf001 --keep
  Delete workflow 'wf001' keeping the local file.

See code: lib/commands/delete-workflow.js

makerops deploy [OBJECT] [ID]

Deploy functions/workflows/etc

USAGE
  $ makerops deploy [OBJECT] [ID]

OPTIONS
  -c, --config=config  Config file
  -f, --force          Force deployment (do not check if source code modified)
  -i, --ignore_npm     Ignore NPM files (package.json, package-lock.json)
  -n, --no_tag         Do not tag the head commit
  -o, --org=org        Org ID
  -p, --publish        Publish the new version
  -y, --yes            Assume yes for any questions (do not prompt)

EXAMPLES
  $ makerops deploy
  deploy all objects modified since last successful deployment (tag)
    
  $ makerops deploy workflow wf001 --no_tag
  deploy workflow '001' if modified since last successful deployment, not tagging the repo

See code: lib/commands/deploy.js

makerops deploy-functions [FUNCTION]

Deploy function/s

USAGE
  $ makerops deploy-functions [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -f, --force          Force deployment (do not check if source code modified)
  -i, --ignore_npm     Ignore NPM files (package.json, package-lock.json)
  -n, --no_tag         Do not tag the head commit
  -o, --org=org        Org ID
  -p, --publish        Publish the new version
  -y, --yes            Assume yes for any questions (do not prompt)

EXAMPLES
  $ makerops deploy-functions
  deploy all functions modified since last successful deployment (tag)
    
  $ makerops deploy-functions helloWorld
  deploy the 'helloWorld' function if modified since last successful deployment (tag)

See code: lib/commands/deploy-functions.js

makerops deploy-webhooks [WEBHOOKID]

Deploy Webhook/s

USAGE
  $ makerops deploy-webhooks [WEBHOOKID]

OPTIONS
  -c, --config=config  Config file
  -f, --force          Force deployment (do not check if source code modified)
  -i, --ignore_npm     Ignore NPM files (package.json, package-lock.json)
  -n, --no_tag         Do not tag the last deployment
  -o, --org=org        Org ID
  -p, --publish        Publish version
  -y, --yes            Assume yes for any questions (do not prompt)

EXAMPLES
  $ makerops deploy-webhook
  deploy all webhooks
    
  $ makerops deploy-webhooks helloWorld
  deploy the 'helloWorld' webhook

See code: lib/commands/deploy-webhooks.js

makerops deploy-workflows [WORKFLOWID]

Deploy Workflow/s

USAGE
  $ makerops deploy-workflows [WORKFLOWID]

OPTIONS
  -c, --config=config  Config file
  -f, --force          Force deployment (do not check if source code modified)
  -i, --ignore_npm     Ignore NPM files (package.json, package-lock.json)
  -n, --no_tag         Do not tag the last deployment
  -o, --org=org        Org ID
  -p, --publish        Publish version
  -y, --yes            Assume yes for any questions (do not prompt)

EXAMPLES
  $ makerops deploy-workflow
  deploy all workflows
    
  $ makerops deploy-workflow helloWorld
  deploy the 'helloWorld' workflow

See code: lib/commands/deploy-workflows.js

makerops get [FUNCTION]

Get function details

USAGE
  $ makerops get [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  -r, --results        Results only

EXAMPLE
  $ makerops get helloWorld
  return details about the 'helloWorld' function

See code: lib/commands/get.js

makerops help [COMMAND]

display help for makerops

USAGE
  $ makerops help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

makerops init [FOLDER]

Initialize a new project

USAGE
  $ makerops init [FOLDER]

OPTIONS
  -o, --org=org          Organization ID
  -p, --path=path        Path to function entry folder
  -v, --version=version  Config version

EXAMPLE
  $ makerops init

See code: lib/commands/init.js

makerops list [OBJECTS]

List tracked objects (functions/workflows/webhooks)

USAGE
  $ makerops list [OBJECTS]

OPTIONS
  -c, --config=config  Config file

EXAMPLES
  $ makerops list
  List all functions/workflows/webhooks tracked in this project
    
  $ makerops list functions
  List all functions tracked in this project

See code: lib/commands/list.js

makerops list-functions

List functions tracked in this project

USAGE
  $ makerops list-functions

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID

EXAMPLE
  $ makerops list-functions
  List all functions in this project

See code: lib/commands/list-functions.js

makerops list-webhooks

List webhooks tracked in this project

USAGE
  $ makerops list-webhooks

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID

EXAMPLE
  $ makerops list-webhooks
  List all webhooks in this project

See code: lib/commands/list-webhooks.js

makerops list-workflows

List workflows tracked in this project

USAGE
  $ makerops list-workflows

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID

EXAMPLE
  $ makerops list-workflows
  List all workflows in this project

See code: lib/commands/list-workflows.js

makerops login ORGID

Login to MakerOps

USAGE
  $ makerops login ORGID

OPTIONS
  -a, --app_url=app_url  MakerOps Application URL
  -c, --config=config    Config file
  -u, --api_url=api_url  MakerOps API URL

EXAMPLE
  $ makerops login org-name
  Login to MakerOps using org <org-name>

See code: lib/commands/login.js

makerops publish [FUNCTION] [VERSION]

Publish a function version (make it available in Workflows)

USAGE
  $ makerops publish [FUNCTION] [VERSION]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  -r, --results        Results only

EXAMPLES
  $ makerops publish helloWorld
  Publish the latest version of the 'helloWorld' function

  $ makerops publish helloWorld 3
  Publish version 3 of the 'helloWorld' function

See code: lib/commands/publish.js

makerops run OBJECT ID

Run/invoke an object (function/workflow)

USAGE
  $ makerops run OBJECT ID

OPTIONS
  -c, --config=config    Config file
  -l, --local            Run locally
  -o, --org=org          Org ID
  -p, --payload=payload  [default: {}] JSON payload
  -r, --results          Results only
  -v, --version=version  Version to execute

EXAMPLES
  $ makerops run workflow wf001
  Execute workflow 'wf001'
    
  $ makerops run function fn001
  Execute function 'fn001'

See code: lib/commands/run.js

makerops run-function [FUNCTION]

Invoke a function

USAGE
  $ makerops run-function [FUNCTION]

OPTIONS
  -c, --config=config    Config file
  -l, --local            Run locally
  -o, --org=org          Org ID
  -p, --payload=payload  [default: {}] JSON payload
  -r, --results          Results only
  -v, --version=version  Version to execute

EXAMPLE
  $ makerops run-function helloWorld
  run the 'helloWorld' function

See code: lib/commands/run-function.js

makerops run-workflow [WORKFLOWID]

Run a workflow

USAGE
  $ makerops run-workflow [WORKFLOWID]

OPTIONS
  -c, --config=config    Config file
  -l, --local            Run locally
  -o, --org=org          Org ID
  -p, --payload=payload  [default: {}] JSON payload
  -r, --results          Results only
  -v, --version=version  Version to execute

EXAMPLE
  $ makerops run-workflow wf01
  run the 'wf01' workflow

See code: lib/commands/run-workflow.js

makerops track OBJECT ID

Start tracking object (function/workflow/webhook)

USAGE
  $ makerops track OBJECT ID

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  --dir=dir            Directory under base path in which to save the file

EXAMPLES
  $ makerops track workflow wf001
  Start tracking workflow 'wf001'
    
  $ makerops track function fn001
  Start tracking function 'fn001'

See code: lib/commands/track.js

makerops track-function [FUNCTION]

Start tracking an existing function

USAGE
  $ makerops track-function [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  --dir=dir            Directory under base path in which to save the file

EXAMPLE
  $ makerops track-function fn1023
  Start tracking the 'fn1023' function

See code: lib/commands/track-function.js

makerops track-webhook [WEBHOOK]

Start tracking an existing webhook

USAGE
  $ makerops track-webhook [WEBHOOK]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  --dir=dir            Directory under base path in which to save the file

EXAMPLE
  $ makerops track-webhook wh001
  Start tracking the webhook 'wh001'

See code: lib/commands/track-webhook.js

makerops track-workflow [WORKFLOW]

Start tracking an existing workflow

USAGE
  $ makerops track-workflow [WORKFLOW]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID
  --dir=dir            Directory under base path in which to save the file

EXAMPLE
  $ makerops track-workflow wf1023
  Start tracking the 'wf1023' workflow

See code: lib/commands/track-workflow.js

makerops versions [FUNCTION]

List function versions

USAGE
  $ makerops versions [FUNCTION]

OPTIONS
  -c, --config=config  Config file
  -o, --org=org        Org ID

EXAMPLE
  $ makerops get helloWorld
  return details about the 'helloWorld' function

See code: lib/commands/versions.js

Readme

Keywords

Package Sidebar

Install

npm i @makeropsinc/cli

Repository

github.com/makeropsinc/cli

Homepage

github.com/@makeropsinc/cli

Weekly Downloads

4

Version

2.2.2

License

MIT

Unpacked Size

231 kB

Total Files

113

Last publish

Collaborators

  • x-devops-bot
Try on RunKit
Report malware