Installation

This placeholder page demonstrates how fenced code blocks, titled code blocks, and tables render in the documentation.

Install the CLI

Install the command-line tool with your package manager of choice:

npm install -g example-cli

Verify the installation by printing the version:

example-cli --version

Create a project

Initialize a new project. The command below writes a configuration file into the current directory:

example.config.json
{
  "name": "my-project",
  "version": "1.0.0",
  "environment": "development",
  "features": {
    "telemetry": false
  }
}

Configuration reference

The generated configuration accepts the following top-level fields:

FieldTypeDefaultDescription
namestring—Human-readable project name.
versionstring1.0.0Semantic version of the project.
environmentstringdevelopmentOne of development or production.
featuresobject{}Optional feature flags.

Troubleshooting

If the example-cli command is not found after installation, make sure your package manager's global bin directory is on your PATH. Continue to the Quickstart once installation succeeds.