Skip to main content

Using the CLI

The CALM CLI provides a set of commands that allow you to interact with CALM’s architecture model. This section will cover the basics of using the CLI, including accessing help, understanding command structure, and common options.

Basic CLI Usage​

Once installed, you can access the CLI by typing calm in your terminal. This command will display the help text and available commands:

calm

You should see output similar to the following:

Usage: calm [options] [command]

A set of tools for interacting with the Common Architecture Language Model (CALM)

Options:
  -V, --version               output the version number
  -h, --help                  display help for command

Commands:
  generate [options]          Generate an architecture from a CALM pattern file.
  validate [options]          Validate that an architecture conforms to a given CALM pattern.
  server [options]            Start a HTTP server to proxy CLI commands. (experimental)
  template [options]          Generate files from a CALM model using a template bundle, a single file, or a directory of templates
  docify [options]            Generate a documentation website from your CALM model using a template or template directory
  copilot-chatmode [options]  DEPRECATED (use init-ai): Augment a git repository with a CALM VSCode chatmode for AI assistance
  init-ai [options]           Augment a git repository with AI assistance for CALM
  help [command]              display help for command

AI-Powered Development​

CALM CLI includes AI-powered development assistance through the init-ai command. This feature integrates with various IDEs and Coding Assistants to provide intelligent help with architecture modeling. Learn more in the CALM AI Tools section.