Install
Install the openfabriq command and log in to Claude Code and GitHub, on the machine that runs the engine.
You install openfabriq once, on the machine that runs the engine: your computer to start with, a server later. Your repository only receives the openfabriq/ folder.
- Your factory, in readable files
- Versioned with your code
- What this page installs
- Runs the agents with your Claude Code
- Talks to GitHub with your gh login
With Claude Code
Paste this prompt in Claude Code. It does the steps below, and stops when only you can do the next one, such as a login.
Let your coding agent install it. One prompt for Claude Code checks your machine, installs openfabriq and checks your logins. It never logs in or installs system packages for you: it tells you the command.
Read the prompt
Install openfabriq on this machine. openfabriq runs AI agents described in an openfabriq/ folder of a repository, on this machine, with Claude Code and the gh CLI: https://github.com/openfabriq/openfabriq Do everything yourself, step by step: run the commands, do not hand them to me. Stop only for what you cannot do: a command that asks for my password (sudo), a login in my browser, or a choice that is mine. Then give me the exact command or question, wait for my answer, and go on. Never print a token or a password. 1. Check that this machine runs macOS or Linux. On Windows, stop: openfabriq does not run there. 2. Install what is missing: - openfabriq, if `command -v openfabriq` finds nothing: with Homebrew when `brew` exists, `brew install openfabriq/tap/openfabriq`, which also installs Node and the GitHub CLI; otherwise `npm install -g openfabriq`, which needs Node 24 or later (`node --version`; if Node is missing or older, tell me how to install it). If npm refuses to write its global folder, do not use sudo: tell me. - the GitHub CLI, if `command -v gh` finds nothing: `brew install gh`, or on Linux the command for my distribution (it needs sudo). - on Linux, the sandbox of the agents' shell: bubblewrap, socat and ripgrep (`sudo apt install bubblewrap socat ripgrep` on Debian and Ubuntu). `openfabriq` with no arguments then lists its commands. 3. The logins. Claude Code is logged in already, since you run in it. If `gh auth status` says I am not logged in, ask me to run `gh auth login` in my terminal (it opens my browser) and wait. If `git config user.name` or `git config user.email` is empty, ask me for the name and email the commits should carry, and set them with `git config --global`. 4. Run `openfabriq doctor`. It checks the logins, the git identity and, on Linux, the sandbox tools. Fix each ✗ line yourself when you can, as above; otherwise give me its fix and wait. It also says there is no factory here: that is expected. 5. Finish with what is ready, then the next step: `openfabriq init` in my repository, which writes the factory with Claude Code.
By hand
Install the command
On macOS or Linux. Windows is not supported: the sandbox of the engine's commands does not run there. Homebrew also installs Node and the GitHub CLI:
brew install openfabriq/tap/openfabriqOr with npm, and Node.js 24 or later (on Linux with a system Node, add sudo):
npm install -g openfabriqLog in
Agents run with your Claude Code, and the engine talks to GitHub with the GitHub CLI: no token to create. Install Claude Code if needed (with Homebrew: brew install --cask claude-code), then log in to both:
npm install -g @anthropic-ai/claude-code
claude auth login && gh auth loginCommits are made under your git identity: git config user.name and git config user.email must be set.
On Linux, also install the sandbox of the agents' shell and the engine's commands, for example sudo apt install bubblewrap socat ripgrep: without it, the engine's commands fail during a run.
Check
In your repository:
openfabriq doctorIt checks all of the above and says how to fix what is missing. Once the factory exists, it also checks every program the factory starts (composer for its setup, for example) and prints what each skill says it needs, such as a browser. It installs nothing.
Next: the Quickstart.
To update or uninstall openfabriq, and where it keeps its files: Local. Which models agents run on, with which Claude credential: Models.
The Claude Code plugin
openfabriq init opens Claude Code with openfabriq's plugin for that conversation. To have it in every conversation, install it once (optional):
claude plugin install openfabriq --marketplace https://github.com/openfabriq/openfabriqIt brings:
/openfabriq:setup, which writes or changesopenfabriq/asinitdoes;/openfabriq:diagnose, which explains why an automation did not start or a run failed;- the read-only MCP server.
Claude Code also uses them on its own when you ask, for example "why did nothing happen on issue 12?".