Skip to content

Getting started

Angee is a self-managed stack manager: the angee CLI renders a project host, materializes its framework sources, and runs its local and container Services as one stack.

Install

With Homebrew on macOS or Linux:

sh
brew install ang-ee/tap/angee

Or use the release installer:

sh
curl -fsSL https://raw.githubusercontent.com/ang-ee/angee-operator/main/scripts/install.sh | sh

You also need Docker for container Services, process-compose for local Services, and git for git Sources.

Create your first stack

Run these commands from a normal working directory:

sh
angee init myproject   # dev is the default template; add -y for non-interactive use
cd myproject
angee dev              # materialize sources and boot everything

On macOS, do not create the stack under /tmp: that path is symlinked, and a known operator persistence-check bug currently rejects it.

There is no --dev flag. The dev template is the default value of -t/--template, while -y/--yes accepts its defaults non-interactively. angee dev is the bring-up command for the complete development stack; angee up starts container Services only.

Where to next

  • Concepts explains Stacks, Sources, Workspaces, Services, Hosts, and the operator boundary.
  • Commands lists every CLI command and flag.
  • Templates covers template discovery and selection.
  • The framework guide introduces the Django/React runtime and the addon model you build with.

Released under the AGPL-3.0 License.