Install you-agent-factory

Install the you CLI, confirm it resolves on PATH, pick a worker provider, and install a packaged factory from the embedded catalog.

Install

The published release entrypoint downloads the you binary for your operating system and puts it on your PATH. It installs the CLI only; it does not start a factory or write any configuration.

macOS / Linux

curl -fsSL https://github.com/portpowered/you-agent-factory/releases/latest/download/install.sh | sh

Windows (PowerShell)

irm https://github.com/portpowered/you-agent-factory/releases/latest/download/install.ps1 | iex

The installer writes the binary and updates PATH for new shells. Open a new terminal, or reload your shell profile, before running you for the first time.

Confirm The Install

Print the root help to confirm the shell resolves you and to see the top-level command groups.

you -h

The binary also carries its own reference topics offline. Printing the index shows every topic you can read without a network connection.

you docs

Choose A Provider

A worker provider is the agent or model runtime that actually executes work — the coding agent or inference backend behind each worker. you init records a default provider and an optional default model so factories do not have to name one. Run it with no flags for an interactive prompt, or pass --provider to configure it non-interactively in a script or CI job.

Configure a provider interactively

you init

Configure a provider non-interactively

you init --provider codex

Provider names are not fixed by this documentation — the binary reports the ones it can select, including any Agent Client Protocol providers an operator added.

you workers list

Install A Packaged Factory

Packaged factories are complete workflows that ship inside the binary. Installing one copies its definition into your named factory root so you can run it, read it, and edit it.

you init --package @you/goal

By default the packaged factory installs into the global named factory root under your home directory. Pass --dir to install it into a project-local root instead, --format to choose the authored root definition format, and --replace to overwrite a directory that already exists. Listing factories reads exactly one root at a time and never merges the two, so point --dir at the global root to see what --package installed.

you factory list --dir ~/.you-agent-factory/factories

Packaged Factory Reference — every shipped factory and its source

Where Things Land

Provider defaults are operator settings and live in ~/.you-agent-factory/config.json. Named factories installed with --package land under ~/.you-agent-factory/factories unless --dir points somewhere else. A factory you author for one project lives beside that project, in ./factory/factory.json.

Common Pitfalls

The most common failure after install is a missing provider: workers dispatch, find no configured runtime, and the run ends immediately. Configure a provider before the first run. The second most common is an installer that finished in a shell whose PATH was already loaded — open a new terminal before deciding the install failed.

Next Steps

With a provider configured and a packaged factory installed, the shortest useful next step is to run one end to end.