fmc

A CLI to operate on Formicarium

• Usage
• Commands

Usage

$ npm install -g @formicarium/cli
$ fmc COMMAND
running command...
$ fmc (-v|--version|version)
@formicarium/cli/1.7.2 darwin-x64 node-v12.12.0
$ fmc --help [COMMAND]
USAGE
  $ fmc COMMAND
...

Commands

• fmc autocomplete [SHELL]
• fmc code:push [SERVICENAME]
• fmc code:watch [SERVICENAME]
• fmc config GETORSET CONFIGPATH
• fmc curl METHOD APPLICATIONNAME PATH
• fmc devspace:create ID
• fmc devspace:delete NAME
• fmc devspace:info
• fmc devspace:list
• fmc devspace:services [NAME]
• fmc devspace:use NAME
• fmc git:push [SERVICENAME]
• fmc git:setup [NAME] [LOCALFOLDER]
• fmc help [COMMAND]
• fmc repl [SERVICENAME] [INTERFACENAME]
• fmc service:delete NAME
• fmc service:deploy:image SERVICENAME
• fmc service:deploy:local [SERVICENAME] [LOCALPATH]
• fmc service:deploy:set [FILEPATH]
• fmc service:list
• fmc service:logs NAME
• fmc service:restart NAME
• fmc service:status
• fmc setup URL

fmc autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ fmc autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

fmc code:push [SERVICENAME]

Configures local fmcgit and hive

USAGE
  $ fmc code:push [SERVICENAME]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -w, --watch
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc code:push sr-barriga

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

fmc code:watch [SERVICENAME]

Configures local fmcgit and hive

USAGE
  $ fmc code:watch [SERVICENAME]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc code:watch sr-barriga

See code: src/commands/code/watch.ts

fmc config GETORSET CONFIGPATH

Configures fmc CLI to one cluster

USAGE
  $ fmc config GETORSET CONFIGPATH

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: json] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc config get soilUrl

See code: src/commands/config.ts

fmc curl METHOD APPLICATIONNAME PATH

Make a curl request to the service in the devspace being used. You can pass any extra arguments to curl at the end of the command

USAGE
  $ fmc curl METHOD APPLICATIONNAME PATH

OPTIONS
  -h, --help                 show CLI help
  -i, --interface=interface  [default: default] Interface to send the request
  -o, --output=output        [default: table] set output type
  -x, --extended             show extra columns
  --columns=columns          only show provided columns (comma-separated)
  --csv                      output is csv format
  --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
  --sort=sort                property to sort by (prepend '-' for descending)

EXAMPLES
  $ fmc curl GET purgatory /api/version
  $ fmc curl POST -i default purgatory /do/something
  $ fmc curl POST purgatory /do/something -d '{...}'
  $ fmc curl GET s0-purgatory /api/version

See code: src/commands/curl.ts

fmc devspace:create ID

Creates a Devspace

USAGE
  $ fmc devspace:create ID

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --arg=arg
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLES
  $ fmc devspace:create paps
  $ fmc devspace:create acq --arg sharded

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

fmc devspace:delete NAME

Deletes a Devspace

USAGE
  $ fmc devspace:delete NAME

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc devspace:delete paps

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

fmc devspace:info

Get information for the current devspace

USAGE
  $ fmc devspace:info

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc devspace:info

See code: src/commands/devspace/info.ts

fmc devspace:list

List availables Devspaces

USAGE
  $ fmc devspace:list

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc devspace:list

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

fmc devspace:services [NAME]

Lists the services in your devspace

USAGE
  $ fmc devspace:services [NAME]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc devspace:services

See code: src/commands/devspace/services.ts

fmc devspace:use NAME

Get version information about the current devspace

USAGE
  $ fmc devspace:use NAME

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc devspace:use paps

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

fmc git:push [SERVICENAME]

Configures local fmcgit and hive

USAGE
  $ fmc git:push [SERVICENAME]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -w, --watch
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc git:push

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

fmc git:setup [NAME] [LOCALFOLDER]

Deploys service

USAGE
  $ fmc git:setup [NAME] [LOCALFOLDER]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -s, --shard=shard    service shard
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:setup .

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

fmc help [COMMAND]

display help for fmc

USAGE
  $ fmc help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

fmc repl [SERVICENAME] [INTERFACENAME]

Connects to remote repl. If no service is provided, connects on Hive's Repl

USAGE
  $ fmc repl [SERVICENAME] [INTERFACENAME]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLES
  $ fmc repl
  $ fmc repl purgatory
  $ fmc repl purgatory common-repl

See code: src/commands/repl.ts

fmc service:delete NAME

Deletes a service in the current Devspace

USAGE
  $ fmc service:delete NAME

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -s, --shard=shard    service shard
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:delete mancini

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

fmc service:deploy:image SERVICENAME

Deploys service image

USAGE
  $ fmc service:deploy:image SERVICENAME

OPTIONS
  -a, --arg=arg            an arg to be sent to config server
  -f, --filePath=filePath  path to a definition file to be used
  -h, --help               show CLI help
  -o, --output=output      [default: table] set output type
  -x, --extended           show extra columns
  --columns=columns        only show provided columns (comma-separated)
  --csv                    output is csv format
  --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
  --sort=sort              property to sort by (prepend '-' for descending)

EXAMPLES
  $ fmc service:deploy:image my-service
  $ fmc service:deploy:image my-service --arg version=5cfc8f3

See code: src/commands/service/deploy/image.ts

fmc service:deploy:local [SERVICENAME] [LOCALPATH]

Deploys service from local files

USAGE
  $ fmc service:deploy:local [SERVICENAME] [LOCALPATH]

OPTIONS
  -a, --arg=arg            an arg to be sent to config server
  -f, --filePath=filePath  absoluteFilePath
  -h, --help               show CLI help
  -o, --output=output      [default: table] set output type
  -x, --extended           show extra columns
  --columns=columns        only show provided columns (comma-separated)
  --csv                    output is csv format
  --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
  --sort=sort              property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:deploy:local -l . -f my-args.json my-service --arg version=1 --arg xablau=xpto

See code: src/commands/service/deploy/local.ts

fmc service:deploy:set [FILEPATH]

Deploys a service set definition

USAGE
  $ fmc service:deploy:set [FILEPATH]

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:deploy:set my-set.json

See code: src/commands/service/deploy/set.ts

fmc service:list

List services in the current Devspace

USAGE
  $ fmc service:list

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLES
  $ fmc service:list
  $ fmc service:list -o yaml

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

fmc service:logs NAME

A service logs in the current Devspace

USAGE
  $ fmc service:logs NAME

OPTIONS
  -f, --follow=follow  Follow logs
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:logs mancini

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

fmc service:restart NAME

Restart a service deployed in dev mode

USAGE
  $ fmc service:restart NAME

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:restart mancini

See code: src/commands/service/restart.ts

fmc service:status

Restart a service deployed in dev mode

USAGE
  $ fmc service:status

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc service:restart mancini

See code: src/commands/service/status.ts

fmc setup URL

Configures fmc CLI to one cluster

USAGE
  $ fmc setup URL

OPTIONS
  -h, --help           show CLI help
  -o, --output=output  [default: table] set output type
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --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
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLE
  $ fmc setup https://soil.your.host.here

See code: src/commands/setup.ts