# @starlightcms/cli > The official Starlight toolkit. Latest version **0.6.0** (published 2024-06-25) · MIT license · 0 weekly downloads ## Install ```sh npm install @starlightcms/cli pnpm add @starlightcms/cli yarn add @starlightcms/cli bun add @starlightcms/cli ``` Provides the command `starlight`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.6.0 | | Published | 2024-06-25 | | First published | 2023-08-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=16.0.0 | | Dependencies | 16 | | Unpacked size | 128.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Lucas Varela @lucas-varela | | Keywords | oclif | ## Links - npm: https://www.npmjs.com/package/@starlightcms/cli - Repository: https://github.com/starlightcms/cli - Issues: https://github.com/starlightcms/cli/issues - npm.io page: https://npm.io/package/@starlightcms/cli ## Dependencies (16) - [got](https://npm.io/package/got.md) ^11.8.6 - [tar](https://npm.io/package/tar.md) ^6.1.15 - [yup](https://npm.io/package/yup.md) ^1.2.0 - [chalk](https://npm.io/package/chalk.md) ^4.1.2 - [execa](https://npm.io/package/execa.md) ^5.1.1 - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [octokit](https://npm.io/package/octokit.md) ^3.1.0 - [@oclif/core](https://npm.io/package/@oclif/core.md) ^2 - [formdata-node](https://npm.io/package/formdata-node.md) ^4.4.1 - [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^3.0.0 - [@inquirer/prompts](https://npm.io/package/@inquirer/prompts.md) ^3.0.2 - [form-data-encoder](https://npm.io/package/form-data-encoder.md) ^1.9.0 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5 - [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^3.1.8 - [@ungap/structured-clone](https://npm.io/package/@ungap/structured-clone.md) ^1.2.0 - [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^2.0.46 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 0.6.0 (latest) — 2024-06-25 - 0.5.1 — 2024-06-24 - 0.5.0 — 2024-02-29 - 0.4.1 — 2023-11-13 - 0.4.0 — 2023-11-10 - 0.3.1 — 2023-11-06 - 0.3.0 — 2023-10-14 - 0.2.1 — 2023-08-21 - 0.2.0 — 2023-08-21 - 0.1.4 — 2023-08-11 - 0.1.3 — 2023-08-09 - 0.1.2 — 2023-08-07 - 0.1.1 — 2023-08-07 - 0.1.0 — 2023-08-07 ## README oclif-hello-world ================= oclif example Hello World CLI [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main) [![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ npm install -g @starlightcms/cli $ starlight COMMAND running command... $ starlight (--version) @starlightcms/cli/0.6.0 darwin-arm64 node-v16.16.0 $ starlight --help [COMMAND] USAGE $ starlight COMMAND ... ``` # Commands * [`starlight create TEMPLATE [PROJECTNAME]`](#starlight-create-template-projectname) * [`starlight help [COMMANDS]`](#starlight-help-commands) * [`starlight login`](#starlight-login) * [`starlight logout`](#starlight-logout) * [`starlight plugins`](#starlight-plugins) * [`starlight plugins:install PLUGIN...`](#starlight-pluginsinstall-plugin) * [`starlight plugins:inspect PLUGIN...`](#starlight-pluginsinspect-plugin) * [`starlight plugins:install PLUGIN...`](#starlight-pluginsinstall-plugin-1) * [`starlight plugins:link PLUGIN`](#starlight-pluginslink-plugin) * [`starlight plugins:uninstall PLUGIN...`](#starlight-pluginsuninstall-plugin) * [`starlight plugins:uninstall PLUGIN...`](#starlight-pluginsuninstall-plugin-1) * [`starlight plugins:uninstall PLUGIN...`](#starlight-pluginsuninstall-plugin-2) * [`starlight plugins update`](#starlight-plugins-update) * [`starlight template import [FOLDER]`](#starlight-template-import-folder) * [`starlight template validate [FOLDER]`](#starlight-template-validate-folder) ## `starlight create TEMPLATE [PROJECTNAME]` Create an application using a template. ``` USAGE $ starlight create TEMPLATE [PROJECTNAME] [--typescript] [--branch ] [--email --password ] [--organization --workspace-name --workspace-slug ] ARGUMENTS TEMPLATE Web Template name, git repository URL or local directory path PROJECTNAME The name of the project (and directory) that will be created FLAGS --branch= [default: main] Which branch to checkout when cloning Web Templates or a git repository (defaults to "main") --email= E-mail address used to log in. If passed, the --password flag is required. --organization= An organization slug to use when importing content. --password= Password used to log in. If passed, the --email flag is required. --typescript Clone the TypeScript version of a Web Template (if available) --workspace-name= The name of the workspace that should be created when importing content. If passed, the --organization and --workspace-slug flags are required. --workspace-slug= The slug of the workspace that should be created when importing content. If passed, the --organization and --workspace-name flags are required. DESCRIPTION Create an application using a template. This command creates a new application using an existing template by cloning its files locally and configuring it using metadata defined in the template. Templates can be fetched from the Web Templates repository, git repositories, or from a local directory. Web Templates are official Starlight web application templates, learn more at: https://github.com/starlightcms/web-templates Tip: Some Web Templates offer both JavaScript and TypeScript versions. You can choose to clone a TypeScript version by passing a --typescript flag. The CLI will warn you in case the chosen template doesn't have a TypeScript version. EXAMPLES Create an application using the nextjs Web Template $ starlight create nextjs Create an application using a git repository $ starlight create https://github.com/my-org/example-template Create an application using a local template $ starlight create ~/my-company/starlight-templates/example-template Clone the TypeScript version of a Web Template (if available) $ starlight create nextjs --typescript ``` _See code: [dist/commands/create.ts](https://github.com/starlightcms/cli/blob/v0.6.0/dist/commands/create.ts)_ ## `starlight help [COMMANDS]` Display help for starlight. ``` USAGE $ starlight help [COMMANDS] [-n] ARGUMENTS COMMANDS Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for starlight. ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.16/src/commands/help.ts)_ ## `starlight login` Log in with your Starlight account ``` USAGE $ starlight login DESCRIPTION Log in with your Starlight account EXAMPLES $ starlight login ``` _See code: [dist/commands/login.ts](https://github.com/starlightcms/cli/blob/v0.6.0/dist/commands/login.ts)_ ## `starlight logout` Log out from your Starlight account ``` USAGE $ starlight logout DESCRIPTION Log out from your Starlight account EXAMPLES $ starlight logout ``` _See code: [dist/commands/logout.ts](https://github.com/starlightcms/cli/blob/v0.6.0/dist/commands/logout.ts)_ ## `starlight plugins` List installed plugins. ``` USAGE $ starlight plugins [--json] [--core] FLAGS --core Show core plugins. GLOBAL FLAGS --json Format output as json. DESCRIPTION List installed plugins. EXAMPLES $ starlight plugins ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/index.ts)_ ## `starlight plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ starlight plugins:install PLUGIN... ARGUMENTS PLUGIN Plugin to install. FLAGS -f, --force Run yarn install with force flag. -h, --help Show CLI help. -v, --verbose DESCRIPTION Installs a plugin into the CLI. Can be installed from npm or a git url. Installation of a user-installed plugin will override a core plugin. e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. ALIASES $ starlight plugins add EXAMPLES $ starlight plugins:install myplugin $ starlight plugins:install https://github.com/someuser/someplugin $ starlight plugins:install someuser/someplugin ``` ## `starlight plugins:inspect PLUGIN...` Displays installation properties of a plugin. ``` USAGE $ starlight 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 $ starlight plugins:inspect myplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/inspect.ts)_ ## `starlight plugins:install PLUGIN...` Installs a plugin into the CLI. ``` USAGE $ starlight plugins:install PLUGIN... ARGUMENTS PLUGIN Plugin to install. FLAGS -f, --force Run yarn install with force flag. -h, --help Show CLI help. -v, --verbose DESCRIPTION Installs a plugin into the CLI. Can be installed from npm or a git url. Installation of a user-installed plugin will override a core plugin. e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. ALIASES $ starlight plugins add EXAMPLES $ starlight plugins:install myplugin $ starlight plugins:install https://github.com/someuser/someplugin $ starlight plugins:install someuser/someplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/install.ts)_ ## `starlight plugins:link PLUGIN` Links a plugin into the CLI for development. ``` USAGE $ starlight plugins:link PLUGIN ARGUMENTS PATH [default: .] path to plugin FLAGS -h, --help Show CLI help. -v, --verbose 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 $ starlight plugins:link myplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/link.ts)_ ## `starlight plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ starlight plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ starlight plugins unlink $ starlight plugins remove ``` ## `starlight plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ starlight plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ starlight plugins unlink $ starlight plugins remove ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/uninstall.ts)_ ## `starlight plugins:uninstall PLUGIN...` Removes a plugin from the CLI. ``` USAGE $ starlight plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Removes a plugin from the CLI. ALIASES $ starlight plugins unlink $ starlight plugins remove ``` ## `starlight plugins update` Update installed plugins. ``` USAGE $ starlight plugins update [-h] [-v] FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Update installed plugins. ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.2.0/src/commands/plugins/update.ts)_ ## `starlight template import [FOLDER]` import a template's schema and content into Starlight ``` USAGE $ starlight template import [FOLDER] ARGUMENTS FOLDER template folder DESCRIPTION import a template's schema and content into Starlight EXAMPLES $ starlight template import ``` _See code: [dist/commands/template/import.ts](https://github.com/starlightcms/cli/blob/v0.6.0/dist/commands/template/import.ts)_ ## `starlight template validate [FOLDER]` validate a template's metadata ``` USAGE $ starlight template validate [FOLDER] ARGUMENTS FOLDER template folder to validade DESCRIPTION validate a template's metadata EXAMPLES $ starlight template validate ``` _See code: [dist/commands/template/validate.ts](https://github.com/starlightcms/cli/blob/v0.6.0/dist/commands/template/validate.ts)_ --- _Source: https://npm.io/package/@starlightcms/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._