Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

codemason

1.0.4 • Public • Published

Mason CLI

Installation

Install the Mason CLI as a global NPM package:

npm install --global codemason

Prerequisites: Git, Docker

Usage

$ npm install -g codemason
$ mason COMMAND
running command...
$ mason (-v|--version|version)
codemason/1.0.4 darwin-x64 node-v10.11.0
$ mason --help [COMMAND]
USAGE
  $ mason COMMAND
...

Commands

mason apps

list your apps

USAGE
  $ mason apps

OPTIONS
  -e, --environment=environment  [default: development] the environment of apps to list

See code: src/commands/apps.js

mason apps:create NAME

create a new app

USAGE
  $ mason apps:create NAME

OPTIONS
  -e, --environment=environment  [default: development] the environment to create the app in
  -n, --no-remote                do not add a git remote
  -r, --remote=remote            [default: codemason] the git remote to create

ALIASES
  $ mason create

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

mason apps:deploy NAME

deploy an app

USAGE
  $ mason apps:deploy NAME

OPTIONS
  -c, --compose-file=compose-file  [default: docker-compose.yml] path to a docker compose file
  -e, --environment=environment    [default: development] the environment to deploy the app to
  -m, --mason-json=mason-json      path to a mason json file
  --env-file=env-file              [default: .env] path to env file to load
  --no-env-file

ALIASES
  $ mason deploy

See code: src/commands/apps/deploy.js

mason apps:destroy NAME

permanently destroy an app

USAGE
  $ mason apps:destroy NAME

OPTIONS
  -e, --environment=environment  [default: development] the environment of the app

See code: src/commands/apps/destroy.js

mason auth

login to your Codemason account

USAGE
  $ mason auth

OPTIONS
  -e, --email=email        email
  -p, --password=password  password

ALIASES
  $ mason login

See code: src/commands/auth.js

mason auth:logout

logout of your Codemason account

USAGE
  $ mason auth:logout

ALIASES
  $ mason logout

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

mason auth:token

display api token

USAGE
  $ mason auth:token

ALIASES
  $ mason token

See code: src/commands/auth/token.js

mason auth:whoami

display user info

USAGE
  $ mason auth:whoami

ALIASES
  $ mason whoami

See code: src/commands/auth/whoami.js

mason config

list cli config

USAGE
  $ mason config

See code: src/commands/config.js

mason config:get KEY

get cli config value

USAGE
  $ mason config:get KEY

See code: src/commands/config/get.js

mason config:set KEY VALUE

set a cli config value

USAGE
  $ mason config:set KEY VALUE

See code: src/commands/config/set.js

mason config:unset KEY

unset a cli config value

USAGE
  $ mason config:unset KEY

See code: src/commands/config/unset.js

mason craft KIT

docker powered dev environments that just work

USAGE
  $ mason craft KIT

ARGUMENTS
  KIT  craft kit to use

OPTIONS
  -w, --with=with                  specify services to craft your app with
  --docker-compose=docker-compose  docker-compose.yml template path
  --dockerfile=dockerfile          dockerfile template path
  --gitlab-ci=gitlab-ci            .gitlab-ci.yml template path

See code: @codemason/mason-cli-craft

mason git:remote APP

add a git remote

USAGE
  $ mason git:remote APP

OPTIONS
  -r, --remote=remote  name to give git remote

See code: src/commands/git/remote.js

mason help [COMMAND]

display help for mason

USAGE
  $ mason help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

mason plugins

list installed plugins

USAGE
  $ mason plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ mason plugins

See code: @oclif/plugin-plugins

mason plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ mason plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ mason plugins:add

EXAMPLES
  $ mason plugins:install myplugin 

  $ mason plugins:install https://github.com/someuser/someplugin

  $ mason plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

mason plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ mason plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLE
  $ mason plugins:link myplugin

See code: @oclif/plugin-plugins

mason plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ mason plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ mason plugins:unlink
  $ mason plugins:remove

See code: @oclif/plugin-plugins

mason plugins:update

update installed plugins

USAGE
  $ mason plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

mason services

list your services

USAGE
  $ mason services

OPTIONS
  -e, --environment=environment  [default: development] the environment of services to list

See code: src/commands/services.js

mason services:create SERVICE

create a new service

USAGE
  $ mason services:create SERVICE

ARGUMENTS
  SERVICE  service to create formatted as `<app>/<service>`

OPTIONS
  -c, --command=command          command for service to run
  -e, --environment=environment  [default: development] the environment to access
  -i, --image=image              image for service to run
  -l, --link=link                link to another service
  -p, --port=port                ports to define on service
  -v, --volume=volume            volume to mount on service
  --env=env                      env variable available to the service
  --env-file=env-file            path to env file to load

See code: src/commands/services/create.js

mason services:destroy SERVICE

permanently destroy an app

USAGE
  $ mason services:destroy SERVICE

ARGUMENTS
  SERVICE  service to destroy formatted as `<app>/<service>`

OPTIONS
  -e, --environment=environment  [default: development] the environment the app is located in

See code: src/commands/services/destroy.js

mason services:upgrade SERVICE

upgrade a service

USAGE
  $ mason services:upgrade SERVICE

ARGUMENTS
  SERVICE  service to create formatted as `<app>/<service>`

OPTIONS
  -c, --command=command          command for service to run
  -e, --environment=environment  [default: development] the environment the service is located in
  -i, --image=image              image for service to run
  -l, --link=link                link to another service
  -p, --port=port                ports to define on service
  -v, --volume=volume            volume to mount on service
  --cancel                       cancel an upgrade
  --cancel-rollback              cancel a rollback
  --env=env                      env variable available to the service
  --env-file=env-file            path to env file to load
  --finish                       finish an upgrade
  --rollback                     rollback an upgrade

See code: src/commands/services/upgrade.js

mason update [CHANNEL]

update the mason CLI

USAGE
  $ mason update [CHANNEL]

See code: @oclif/plugin-update

Additional Documentation

Additional documentation for the Mason CLI can be found on the Codemason website.

Keywords

install

npm i codemason

Downloadsweekly downloads

69

version

1.0.4

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability