Command line

Coming soon

The Keystone CLI is in development. This page is reserved for its documentation; the commands below describe intent, not a released tool.

Keystone is a compiler, and you use it through a template. The Keystone CLI is the tool that will make working with those templates smoother — the way the dotnet command line tool works with .NET projects and solutions.

Today, starting and managing a project is a manual flow: create a repository from a template, edit project.conf and pandoc.yaml, and drive builds with make. The CLI is meant to streamline that end to end — scaffolding a new project from a chosen template, wiring up configuration, managing the project as it grows, and upgrading an existing project to a newer Keystone release — so getting from idea to first build, and from one release to the next, is a single command rather than a checklist. Until it ships, Upgrading your project covers the manual path.

An early version already exists in the open at keystone-cli, with basic commands working. It predates the current engine and is being brought up to date now that the engine is solid — so it isn't the recommended way to start yet.

Details, commands, and installation will be documented here when the CLI is announced. Until then, the Quickstart is the way to begin, and make help lists the commands your template provides. For where this and the rest of Keystone are headed, see The road ahead.