CLI

The @archibald/cli package is the main entry point for getting up and running with an Archibald application and for using functionality including running a development server and building out your Archibald application for deployment.

Installation

Run following command to install the @archibald/cli package:

npm install -D @archibald/cli

info

The Archibald CLI should be used in the context of an Archibald project. If you need to create a new Archibald project please refer to Quick start.

To verify that installation completed successfully do the following:

1. Add a NPM script to the package.json file to run the Archibald CLI:

"scripts": {
  "arc": "archibald"
}

2. Run the Archibald CLI:

❯ npm run arc -- --help

> my-project@0.0.1 arc
> archibald --help

Usage: archibald|arc [options] [command]

Options:
  -v, --version               output the version number
  -h, --help                  Show help for the command.

Commands:
  add|a [options] <function>  Add a new functionality to an existing project.
  build|b [options]           Build the project and make it ready for deployment.
  depolier|dep [options]      Upload the current project to a registry.
  docker|d [options]          Build and upload a docker image.
  link|lnk [options]          Link an archibald development environment into current project
  lint|l [options]            Lint an existing project.
  package|p [options]         Package a project with configured environments.
  e2e|e [options]             Run End to End test for an existing project.
  maestro|mae [options]       Run Maestro native E2E flows.
  serve|srv [options]         Start the development server.
  storybook|sb [options]      Start a storybook development instance.
  test|t [options]            Test an existing project.
  help [command]              display help for command

Available commands

info

All descriptions can also be viewed in the terminal. E.g. to see all available options for the serve command type npm run arc serve -- --help or simply npm run arc serve -- -h.

Command	Description
add	Add a new functionality to an existing project.
build	Build the project and make it ready for deployment.
depolier	Upload the current project to a registry.
docker	Build and upload a docker image.
link	Link an archibald development environment into current project.
lint	Lint an existing project.
package	Package the project with configured environments.
e2e	Run End to End test for an existing project.
maestro	Run Maestro native E2E flows.
serve	Start the development server.
storybook	Start a storybook development instance.
test	Test an existing project.
upgrade-diff	Install a new version of the template and create a diff.