create-spaceship

Spaceship CLI

• Usage
• Commands

Usage

$ npm install -g create-spaceship
$ create-spaceship COMMAND
running command...
$ create-spaceship (--version)
create-spaceship/0.0.4 darwin-arm64 node-v22.15.0
$ create-spaceship --help [COMMAND]
USAGE
  $ create-spaceship COMMAND
...

Commands

• create-spaceship config get [KEY]
• create-spaceship config set [KEY] [VALUE]
• create-spaceship hello PERSON
• create-spaceship hello world
• create-spaceship help [COMMAND]
• create-spaceship init [DIR] [VAULT]
• create-spaceship plugins
• create-spaceship plugins add PLUGIN
• create-spaceship plugins:inspect PLUGIN...
• create-spaceship plugins install PLUGIN
• create-spaceship plugins link PATH
• create-spaceship plugins remove [PLUGIN]
• create-spaceship plugins reset
• create-spaceship plugins uninstall [PLUGIN]
• create-spaceship plugins unlink [PLUGIN]
• create-spaceship plugins update

create-spaceship config get [KEY]

Retrieves configuration for spaceship

USAGE
  $ create-spaceship config get [KEY] [-d <value>]

ARGUMENTS
  KEY  the config key

FLAGS
  -d, --dir=<value>  spaceship directory

DESCRIPTION
  Retrieves configuration for spaceship

EXAMPLES
  $ create-spaceship config get

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

create-spaceship config set [KEY] [VALUE]

Retrieves configuration for spaceship

USAGE
  $ create-spaceship config set [KEY] [VALUE] [-d <value>]

ARGUMENTS
  KEY    the config key
  VALUE  the config value

FLAGS
  -d, --dir=<value>  spaceship directory

DESCRIPTION
  Retrieves configuration for spaceship

EXAMPLES
  $ create-spaceship config set

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

create-spaceship hello PERSON

Say hello

USAGE
  $ create-spaceship hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ create-spaceship hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

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

create-spaceship hello world

Say hello world

USAGE
  $ create-spaceship hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ create-spaceship hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

create-spaceship help [COMMAND]

Display help for create-spaceship.

USAGE
  $ create-spaceship 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 create-spaceship.

See code: @oclif/plugin-help

create-spaceship init [DIR] [VAULT]

Initialises a new spaceship

USAGE
  $ create-spaceship init [DIR] [VAULT] [-d <value>] [-v <value>]

ARGUMENTS
  DIR    directory for the new spaceship
  VAULT  existing obsidian vault

FLAGS
  -d, --dir=<value>    directory for the new spaceship
  -v, --vault=<value>  existing obsidian Vault

DESCRIPTION
  Initialises a new spaceship

EXAMPLES
  $ create-spaceship init

See code: src/commands/init.ts

create-spaceship plugins

List installed plugins.

USAGE
  $ create-spaceship plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ create-spaceship plugins

See code: @oclif/plugin-plugins

create-spaceship plugins add PLUGIN

Installs a plugin into create-spaceship.

USAGE
  $ create-spaceship 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 create-spaceship.

  Uses npm to install plugins.

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

  Use the CREATE_SPACESHIP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CREATE_SPACESHIP_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ create-spaceship plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ create-spaceship plugins add myplugin

  Install a plugin from a github url.

    $ create-spaceship plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ create-spaceship plugins add someuser/someplugin

create-spaceship plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

create-spaceship plugins install PLUGIN

Installs a plugin into create-spaceship.

USAGE
  $ create-spaceship 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 create-spaceship.

  Uses npm to install plugins.

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

  Use the CREATE_SPACESHIP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CREATE_SPACESHIP_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ create-spaceship plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ create-spaceship plugins install myplugin

  Install a plugin from a github url.

    $ create-spaceship plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ create-spaceship plugins install someuser/someplugin

See code: @oclif/plugin-plugins

create-spaceship plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

create-spaceship plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ create-spaceship plugins remove myplugin

create-spaceship plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ create-spaceship 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

create-spaceship plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ create-spaceship plugins uninstall myplugin

See code: @oclif/plugin-plugins

create-spaceship plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ create-spaceship plugins unlink myplugin

create-spaceship plugins update

Update installed plugins.

USAGE
  $ create-spaceship plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins