@laioutr/cli
v0.3.0
Published
Laioutr CLI
Readme
@laioutr/cli
Laioutr CLI
Usage
$ npm install -g @laioutr/cli
$ laioutr COMMAND
running command...
$ laioutr (--version)
@laioutr/cli/0.3.0 darwin-arm64 node-v22.12.0
$ laioutr --help [COMMAND]
USAGE
$ laioutr COMMAND
...Commands
laioutr help [COMMAND]laioutr pluginslaioutr plugins add PLUGINlaioutr plugins:inspect PLUGIN...laioutr plugins install PLUGINlaioutr plugins link PATHlaioutr plugins remove [PLUGIN]laioutr plugins resetlaioutr plugins uninstall [PLUGIN]laioutr plugins unlink [PLUGIN]laioutr plugins updatelaioutr project fetch-rc [FILENAME]laioutr rc fetch [FILENAME]laioutr rc update [FILENAME]
laioutr help [COMMAND]
Display help for laioutr.
USAGE
$ laioutr 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 laioutr.See code: @oclif/plugin-help
laioutr plugins
List installed plugins.
USAGE
$ laioutr plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ laioutr pluginsSee code: @oclif/plugin-plugins
laioutr plugins add PLUGIN
Installs a plugin into laioutr.
USAGE
$ laioutr 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 laioutr.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ laioutr plugins add
EXAMPLES
Install a plugin from npm registry.
$ laioutr plugins add myplugin
Install a plugin from a github url.
$ laioutr plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ laioutr plugins add someuser/somepluginlaioutr plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ laioutr 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
$ laioutr plugins inspect mypluginSee code: @oclif/plugin-plugins
laioutr plugins install PLUGIN
Installs a plugin into laioutr.
USAGE
$ laioutr 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 laioutr.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LAIOUTR_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LAIOUTR_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ laioutr plugins add
EXAMPLES
Install a plugin from npm registry.
$ laioutr plugins install myplugin
Install a plugin from a github url.
$ laioutr plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ laioutr plugins install someuser/somepluginSee code: @oclif/plugin-plugins
laioutr plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ laioutr 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
$ laioutr plugins link mypluginSee code: @oclif/plugin-plugins
laioutr plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ laioutr 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
$ laioutr plugins unlink
$ laioutr plugins remove
EXAMPLES
$ laioutr plugins remove mypluginlaioutr plugins reset
Remove all user-installed and linked plugins.
USAGE
$ laioutr 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
laioutr plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ laioutr 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
$ laioutr plugins unlink
$ laioutr plugins remove
EXAMPLES
$ laioutr plugins uninstall mypluginSee code: @oclif/plugin-plugins
laioutr plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ laioutr 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
$ laioutr plugins unlink
$ laioutr plugins remove
EXAMPLES
$ laioutr plugins unlink mypluginlaioutr plugins update
Update installed plugins.
USAGE
$ laioutr plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
laioutr project fetch-rc [FILENAME]
Fetches the laioutrrc.json of a project from the cockpit api.
USAGE
$ laioutr project fetch-rc [FILENAME] --cockpitApiHost <value> --cwd <value> -e <value> -s <value> -p <value>
FLAGS
-e, --environmentName=<value> (required) [default: main] environment name
-p, --project=<value> (required) <organization slug>/<project slug>
-s, --projectSecret=<value> (required) project secret
--cockpitApiHost=<value> (required) [default: https://cockpit.laioutr.cloud] cockpit api host
--cwd=<value> (required) [default: /Users/sl/src/laioutr/apps/cli] current working directory
DESCRIPTION
Fetches the laioutrrc.json of a project from the cockpit api.
ALIASES
$ laioutr project fetch-rc
EXAMPLES
$ laioutr project fetch-rclaioutr rc fetch [FILENAME]
Fetches the laioutrrc.json of a project from the cockpit api.
USAGE
$ laioutr rc fetch [FILENAME] --cockpitApiHost <value> --cwd <value> -e <value> -s <value> -p <value>
FLAGS
-e, --environmentName=<value> (required) [default: main] environment name
-p, --project=<value> (required) <organization slug>/<project slug>
-s, --projectSecret=<value> (required) project secret
--cockpitApiHost=<value> (required) [default: https://cockpit.laioutr.cloud] cockpit api host
--cwd=<value> (required) [default: /Users/sl/src/laioutr/apps/cli] current working directory
DESCRIPTION
Fetches the laioutrrc.json of a project from the cockpit api.
ALIASES
$ laioutr project fetch-rc
EXAMPLES
$ laioutr rc fetchSee code: src/commands/rc/fetch.ts
laioutr rc update [FILENAME]
Updates an existing laioutrrc.json file with the latest from the cockpit api.
USAGE
$ laioutr rc update [FILENAME] --cockpitApiHost <value> --cwd <value>
FLAGS
--cockpitApiHost=<value> (required) [default: https://cockpit.laioutr.cloud] cockpit api host
--cwd=<value> (required) [default: /Users/sl/src/laioutr/apps/cli] current working directory
DESCRIPTION
Updates an existing laioutrrc.json file with the latest from the cockpit api.
EXAMPLES
$ laioutr rc updateSee code: src/commands/rc/update.ts
