oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g donq
$ donq COMMAND
running command...
$ donq (--version)
donq/0.0.8 darwin-arm64 node-v20.11.1
$ donq --help [COMMAND]
USAGE
  $ donq COMMAND
...

Commands

• donq aws:ecs:exec
• donq help [COMMAND]
• donq package:backend:create PACKAGENAME
• donq package:frontend:create PACKAGENAME
• donq plugins
• donq plugins:add PLUGIN
• donq plugins:inspect PLUGIN...
• donq plugins:install PLUGIN
• donq plugins:link PATH
• donq plugins:remove [PLUGIN]
• donq plugins:reset
• donq plugins:uninstall [PLUGIN]
• donq plugins:unlink [PLUGIN]
• donq plugins:update
• donq project:create CLIENTNAME PROJECTNAME

donq aws:ecs:exec

Exec command inside ECS container

USAGE
  $ donq aws:ecs:exec [-c <value>]

FLAGS
  -c, --command=<value>  [default: /bin/sh] Command to execute

DESCRIPTION
  Exec command inside ECS container

See code: src/commands/aws/ecs/exec/index.ts

donq help [COMMAND]

Display help for donq.

USAGE
  $ donq help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for donq.

See code: @oclif/plugin-help

donq package:backend:create PACKAGENAME

Create a backend package

USAGE
  $ donq package:backend:create PACKAGENAME

ARGUMENTS
  PACKAGENAME  The name of the package to create

DESCRIPTION
  Create a backend package

See code: src/commands/package/backend/create.ts

donq package:frontend:create PACKAGENAME

Create a frontend package

USAGE
  $ donq package:frontend:create PACKAGENAME

ARGUMENTS
  PACKAGENAME  The name of the package to create

DESCRIPTION
  Create a frontend package

See code: src/commands/package/frontend/create.ts

donq plugins

List installed plugins.

USAGE
  $ donq plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ donq plugins

See code: @oclif/plugin-plugins

donq plugins:add PLUGIN

Installs a plugin into donq.

USAGE
  $ donq plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into donq.

  Uses bundled npm executable to install plugins into /Users/mrbash/.local/share/donq

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

  Use the DONQ_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DONQ_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ donq plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ donq plugins:add myplugin

  Install a plugin from a github url.

    $ donq plugins:add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ donq plugins:add someuser/someplugin

donq plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ donq plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ donq plugins:inspect myplugin

See code: @oclif/plugin-plugins

donq plugins:install PLUGIN

Installs a plugin into donq.

USAGE
  $ donq plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into donq.

  Uses bundled npm executable to install plugins into /Users/mrbash/.local/share/donq

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

  Use the DONQ_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DONQ_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ donq plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ donq plugins:install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ donq plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

donq plugins:link PATH

Links a plugin into the CLI for development.

USAGE
  $ donq plugins:link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  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.


EXAMPLES
  $ donq plugins:link myplugin

See code: @oclif/plugin-plugins

donq plugins:remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ donq plugins:remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ donq plugins:unlink
  $ donq plugins:remove

EXAMPLES
  $ donq plugins:remove myplugin

donq plugins:reset

Remove all user-installed and linked plugins.

USAGE
  $ donq plugins:reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

donq plugins:uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ donq plugins:uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ donq plugins:unlink
  $ donq plugins:remove

EXAMPLES
  $ donq plugins:uninstall myplugin

See code: @oclif/plugin-plugins

donq plugins:unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ donq plugins:unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ donq plugins:unlink
  $ donq plugins:remove

EXAMPLES
  $ donq plugins:unlink myplugin

donq plugins:update

Update installed plugins.

USAGE
  $ donq plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

donq project:create CLIENTNAME PROJECTNAME

Create a project structure

USAGE
  $ donq project:create CLIENTNAME PROJECTNAME

ARGUMENTS
  CLIENTNAME   The name of the client of the project to create
  PROJECTNAME  The name of the project to create

DESCRIPTION
  Create a project structure

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