@crstn/neos-cli

@crstn/neos-cli

A simple, quite opinionated CLI for the Neos CMS.

• Usage
• Commands

Usage

Currently, there is only one command that downloads Neos-Skeleton and continues with some steps from the getting started guide for a convenient project setup.

What it does:

• Clones the repository.
• If set, NEOS_PACKAGE_NAME and COMPOSER_PACKAGE_NAME are replaced (only OS X / BSD is supported at this time).
• Removes the docs folder.
• Removes .git and initiates a new Git repository.
• Installs dependencies with composer install.

$ npm install -g @crstn/neos-cli
$ neos COMMAND
running command...
$ neos (-v|--version|version)
@crstn/neos-cli/0.1.0 darwin-x64 node-v13.11.0
$ neos --help [COMMAND]
USAGE
  $ neos COMMAND
...

If you wish, omit these flags and export the shell variables NEOS_PACKAGE_NAME and COMPOSER_PACKAGE_NAME before using this CLI.

Commands

• neos download [PROJECT_NAME]
• neos help [COMMAND]

neos download [PROJECT_NAME]

download boilerplate for new projects

USAGE
  $ neos download [PROJECT_NAME]

OPTIONS
  -c, --composer_package_name=composer_package_name  new composer package name
  -h, --help                                         show CLI help
  -n, --neos_package_name=neos_package_name          new site package name

EXAMPLE
  $ neos download --neos_package_name="YourCompany.Site" --composer_package_name="yourcompany\/site"

See code: src/commands/download.ts

neos help [COMMAND]

display help for neos

USAGE
  $ neos help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help