Skip to content

CLI ​

  Table of Contents

The Factorial command-line interface (CLI) is in development. It will expose most Factorial API endpoints as terminal commands so that users and software agents can work with Factorial without writing direct HTTP integrations.

API Coverage ​

The CLI will cover most operations available through the Factorial API, including commands for reading and modifying supported records. Some API endpoints may not have a corresponding CLI command.

Discovering Commands ​

The CLI will provide --help output at the top level and for individual commands. This output will describe the available commands, arguments, and options so that users can discover how to perform an operation from the terminal.

AI Agents ​

Factorial expects AI users to have their agents interface with Factorial through the CLI. Agents can inspect the available commands through --help, select the appropriate operation, and invoke it using the same command interface available to people.

Availability ​

The CLI is not yet available. Installation, authentication, and the complete command reference will be documented as development progresses.