@danielgl/steampunk-cli

The Steampunk ultimate CLI

• Usage
• Commands

Usage

$ npm install -g @danielgl/steampunk-cli
$ stk COMMAND
running command...
$ stk (--version)
@danielgl/steampunk-cli/1.0.1 darwin-arm64 node-v22.22.0
$ stk --help [COMMAND]
USAGE
  $ stk COMMAND
...

Commands

• stk help [COMMAND]
• stk make controller NAME
• stk make service NAME
• stk make test NAME
• stk new NAME
• stk plugins
• stk plugins add PLUGIN
• stk plugins:inspect PLUGIN...
• stk plugins install PLUGIN
• stk plugins link PATH
• stk plugins remove [PLUGIN]
• stk plugins reset
• stk plugins uninstall [PLUGIN]
• stk plugins unlink [PLUGIN]
• stk plugins update

stk help [COMMAND]

Display help for stk.

USAGE
  $ stk 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 stk.

See code: @oclif/plugin-help

stk make controller NAME

Create a new controller

USAGE
  $ stk make controller NAME [-r <value>]

ARGUMENTS
  NAME  Name of the controller

FLAGS
  -r, --route=<value>  Route for the controller

DESCRIPTION
  Create a new controller

EXAMPLES
  $ stk make controller UserController

  $ stk make controller UserController --route "/users"

See code: src/commands/make/controller.ts

stk make service NAME

Create a new service

USAGE
  $ stk make service NAME

ARGUMENTS
  NAME  Name of the service

DESCRIPTION
  Create a new service

EXAMPLES
  $ stk make service UserService

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

stk make test NAME

Create a new test for a controller

USAGE
  $ stk make test NAME

ARGUMENTS
  NAME  Name of the controller (e.g. Home)

DESCRIPTION
  Create a new test for a controller

EXAMPLES
  $ stk make test User

See code: src/commands/make/test.ts

stk new NAME

Clone steampunk template and install dependencies

USAGE
  $ stk new NAME

ARGUMENTS
  NAME  Name of the project

DESCRIPTION
  Clone steampunk template and install dependencies

EXAMPLES
  $ stk new my-new-project

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

stk plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ stk plugins

See code: @oclif/plugin-plugins

stk plugins add PLUGIN

Installs a plugin into stk.

USAGE
  $ stk 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 stk.

  Uses npm to install plugins.

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

  Use the STK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the STK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ stk plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ stk plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ stk plugins add someuser/someplugin

stk plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ stk 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
  $ stk plugins inspect myplugin

See code: @oclif/plugin-plugins

stk plugins install PLUGIN

Installs a plugin into stk.

USAGE
  $ stk 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 stk.

  Uses npm to install plugins.

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

  Use the STK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the STK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ stk plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ stk plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ stk plugins install someuser/someplugin

See code: @oclif/plugin-plugins

stk plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ stk 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
  $ stk plugins link myplugin

See code: @oclif/plugin-plugins

stk plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ stk 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
  $ stk plugins unlink
  $ stk plugins remove

EXAMPLES
  $ stk plugins remove myplugin

stk plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ stk 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

stk plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ stk 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
  $ stk plugins unlink
  $ stk plugins remove

EXAMPLES
  $ stk plugins uninstall myplugin

See code: @oclif/plugin-plugins

stk plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ stk 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
  $ stk plugins unlink
  $ stk plugins remove

EXAMPLES
  $ stk plugins unlink myplugin

stk plugins update

Update installed plugins.

USAGE
  $ stk plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins