šŸš€ Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
Sign inDemoInstall
Socket

@payfit/todd-cli

Package Overview
Dependencies
Maintainers
3
Versions
96
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
Package was removed
Sorry, it seems this package was removed from the registry

@payfit/todd-cli

A CLI to manage ToDD

0.66.0
unpublished
next
latest
Source
npm
Version published
Weekly downloads
0
Maintainers
3
Weekly downloads
Ā 
Created
Source

Usage

A CLI to manage ToDD

$ npm install -g @payfit/todd-cli
$ todd COMMAND
running command...
$ todd (-v|--version|version)
@payfit/todd-cli/0.66.0 linux-x64 node-v14.18.2
$ todd --help [COMMAND]
USAGE
  $ todd COMMAND
...

Contribute

See CONTRIBUTE.

Commands

todd active

List active ToDD(s)

USAGE
  $ todd active

OPTIONS
  -e, --extended  Show state, date and author
  -h, --help      show CLI help

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

todd api REFERENCE

Change the ToDD API context

USAGE
  $ todd api REFERENCE

ARGUMENTS
  REFERENCE  prod | staging | local | CUSTOM_URL

OPTIONS
  -h, --help  show CLI help

See code: src/commands/api.ts

todd audit

Audit the CLI versions and tools setup

USAGE
  $ todd audit

OPTIONS
  -h, --help  show CLI help

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

todd autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ todd autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

todd config

Manage the Configuration

USAGE
  $ todd config

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)

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

todd config:get KEY

Get a value from the configuration

USAGE
  $ todd config:get KEY

ARGUMENTS
  KEY  Key from the configuration

OPTIONS
  -h, --help  show CLI help

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

todd config:locate

Get the location of the configuration file

USAGE
  $ todd config:locate

OPTIONS
  -h, --help  show CLI help

See code: src/commands/config/locate.ts

todd config:remove KEY

Remove a value from the configuration

USAGE
  $ todd config:remove KEY

ARGUMENTS
  KEY  Key to delete from the configuration

OPTIONS
  -h, --help  show CLI help

See code: src/commands/config/remove.ts

todd config:set KEY VALUE

Set a value inside the configuration

USAGE
  $ todd config:set KEY VALUE

ARGUMENTS
  KEY    Key to be set in the configuration
  VALUE  Value to set in the configuration

OPTIONS
  -h, --help  show CLI help

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

todd config:setup

Setup the default values for a ToDD

USAGE
  $ todd config:setup

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ todd setup

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

todd create

Create a new ToDD

USAGE
  $ todd create

OPTIONS
  -a, --author=author         Author of the ToDD
  -c, --context=context       [default: ./] Path to the todd file (default .todd.yaml then .todd-dev.yaml)
  -d, --dry                   Run in dry mode
  -h, --help                  show CLI help
  -p, --profile=profile       Profile to use
  -t, --todd=todd             ToDD context to use
  --ci                        Prevent prompting questions and browser open
  --countries=fr|it|es|gb|de  Countries to deploy
  --dbs=client|jetlang        Databases to deploy
  --description=description   Description of the ToDD
  --dev                       Enable services in dev mode
  --no-open                   Prevent opening a browser on the Portal after creation
  --service=service           Define a service from parameters. Format is <service-name>@<channel>
  --tag=tag                   Chart tag to use for local services
  --yes                       Prevent prompting questions

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

todd current

Get the current ToDD context

USAGE
  $ todd current

OPTIONS
  -h, --help  show CLI help

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

todd db

Get information about your DBs

USAGE
  $ todd db

OPTIONS
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

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

todd delete

Delete a ToDD

USAGE
  $ todd delete

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

ALIASES
  $ todd rip

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

todd describe

Get the detail of a ToDD

USAGE
  $ todd describe

OPTIONS
  -e, --extended   Show more information
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

ALIASES
  $ todd get
  $ todd info
  $ todd desc

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

todd dev

Manage the Dev config on your ToDD

USAGE
  $ todd dev

OPTIONS
  -h, --help             show CLI help
  -p, --profile=profile  Profile to use

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

todd dev:check

Check installed required tools

USAGE
  $ todd dev:check

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dev/check.ts

todd dev:connect

(re)Connect to Telepresence

USAGE
  $ todd dev:connect

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dev/connect.ts

todd dev:run

Run intercept with telepresence on your services

USAGE
  $ todd dev:run

OPTIONS
  -c, --context=context  [default: ./] Path to the todd file (default .todd.yaml then .todd-dev.yaml)
  -d, --dry              Just logs commands without execute
  -h, --help             show CLI help
  -t, --todd=todd        ToDD context to use
  -w, --wait=wait        [default: 5000] Milliseconds to wait before running commands

See code: src/commands/dev/run.ts

todd dev:services

Services ready to be use in Dev mode

USAGE
  $ todd dev:services

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ todd dev:service
  $ todd dev:app
  $ todd dev:apps

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

todd dev:stop

Stop Intercepts from Telepresence

USAGE
  $ todd dev:stop

OPTIONS
  -d, --dry        Just logs commands without execute
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

ALIASES
  $ todd leave

See code: src/commands/dev/stop.ts

todd dev:sync

Sync services available in dev mode on ArgoCD

USAGE
  $ todd dev:sync

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dev/sync.ts

todd doc [TYPE]

Open ToDD Documentation

USAGE
  $ todd doc [TYPE]

ARGUMENTS
  TYPE  (cli) [default: doc]
        Which doc you want to open

OPTIONS
  -h, --help  show CLI help

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

todd env

Get the environment of a service

USAGE
  $ todd env

OPTIONS
  -f, --file=file            Save it in a file
  -h, --help                 show CLI help
  -o, --output=json|dotfile  [default: dotfile] Choose the output type
  -s, --service=service      (required) Service to get
  -t, --todd=todd            ToDD context to use

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

todd help [COMMAND]

display help for todd

USAGE
  $ todd help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

todd history

Get the history of a ToDD

USAGE
  $ todd history

OPTIONS
  -e, --extended     Show state, date and author
  -h, --help         show CLI help
  -l, --limit=limit  [default: 10] Maximum commits to show
  -r, --raw          Remove headers and loaders
  -t, --todd=todd    ToDD context to use

ALIASES
  $ todd commits
  $ todd logs
  $ todd lg

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

todd list

List ToDDs

USAGE
  $ todd list

OPTIONS
  -a, --author=author                             Filter on the author
  -d, --dev                                       ToDD with Dev Mode setup
  -e, --extended                                  Show state, date and author
  -h, --help                                      show CLI help
  -r, --raw                                       Remove headers and loaders
  --logging                                       ToDD with Remote Logging setup
  --state=created|resumed|updated|paused|deleted  Filter on the state

ALIASES
  $ todd ls

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

todd mine

List your ToDD(s)

USAGE
  $ todd mine

OPTIONS
  -a, --author=author  Filter on the author
  -h, --help           show CLI help

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

todd open [TYPE]

Open applications from a ToDD

USAGE
  $ todd open [TYPE]

ARGUMENTS
  TYPE  (argocd|github|catalog|app|portal) [default: app]
        Which app you want to open

OPTIONS
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

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

todd pause

Pause a ToDD

USAGE
  $ todd pause

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

ALIASES
  $ todd down
  $ todd stop

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

todd pods

Get the pods from a ToDD

USAGE
  $ todd pods

OPTIONS
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

See code: src/commands/pods.ts

todd rebase

Rebase a ToDD to the latest templates

USAGE
  $ todd rebase

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

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

todd resume

Resume a ToDD

USAGE
  $ todd resume

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use

ALIASES
  $ todd up
  $ todd wake

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

todd status

Get the Status of a ToDD

USAGE
  $ todd status

OPTIONS
  -h, --help       show CLI help
  -t, --todd=todd  ToDD context to use
  --errored

See code: src/commands/status.ts

todd superman

Check non-healthy ToDD(s)

USAGE
  $ todd superman

OPTIONS
  -a, --author=author  Filter on the author
  -h, --help           show CLI help

ALIASES
  $ todd sauron
  $ todd wassup
  $ todd support

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

todd sync

Sync a Service on a ToDD

USAGE
  $ todd sync

OPTIONS
  -h, --help             show CLI help
  -s, --service=service  Services to trigger synchronization
  -t, --todd=todd        ToDD context to use

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

todd use TODD

Define a ToDD to use as context

USAGE
  $ todd use TODD

OPTIONS
  -h, --help  show CLI help

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

Keywords

oclif

FAQs

Package last updated on 28 Dec 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts