cedarcli Manual

CEDAR is made up of many repositories and applications that must be built and run together. cedarcli provides one command-line interface for that work. It keeps common tasks consistent and understands the order and grouping that CEDAR requires.

The CLI works with familiar tools rather than replacing them. Git still manages source, Maven and npm still build artifacts, and Docker still runs containers. cedarcli coordinates those tools at the level of the complete CEDAR system.

Before You Begin

This manual assumes that cedarcli is installed. If it is not, follow the cedarcli installation steps in the Docker installation guide.

The cedarcli alias sources "$CEDAR_HOME/cedar-cli/cli.sh". The wrapper runs the CLI in its own Python environment and preserves your shell's environment and working directory, except when a successful Git navigation command deliberately changes directory. Commands such as build this and publish this therefore operate on the repository you are in.

If environment setup or a command fails, the wrapper returns a nonzero exit status without closing your shell. Scripts can use that status to stop dependent work. Maven cache cleanup and the cheat-sheet opener also report failures through their exit status.

How the Manual Is Organized

The manual follows the path a change takes through CEDAR.

First, Working Across Git Repositories explains how to keep the source estate on the intended branches and identify repositories that need attention. Maven and Building CEDAR then explain how source becomes usable local artifacts.

Publishing Artifacts and Build Trains covers the point at which artifacts leave one machine and become shared inputs for other developers and deployments, and Releasing CEDAR covers turning one of those build trains into a published version.

Finally, Selecting a Deployment Mode introduces the three ways to run CEDAR. The native, hybrid, and Docker chapters show the normal workflow for each mode. A short Other Command Groups page covers the less frequently used inspection, certificate, and deployment helpers.