One command, then codeyam-editor start in your project root.
What you need first. Node on your machine and a project folder. Nothing else: no account, no key, no signup. If you already run Claude Code, you are ready.
The install command. One npm install, globally:
npm install -g @codeyam-editor/codeyam-editor@latest
Running it in your project. Create or navigate to a project folder, or run it in the root directory. Then run codeyam-editor start, and a series of prompts walks you through getting set up.
What it set up for you. A local workspace, a plan file, and the workflow that walks the AI through building and testing. Everything stays on your machine.
If an install goes wrong, start here:
This installs CodeYam from the terminal using the npm package. It is shown on a Mac, so a Windows machine will look slightly different. Take this route if you are already comfortable in a terminal, or if you are newer to it but already run agents like Claude Code there.
One benefit of installing CodeYam in the terminal is that it works with different kinds of agents — Claude Code as well as Codex and Gemini.
Open your terminal in a project. This one is a new project created for the video. Copy the install command, paste it in, and run it. It takes a little while to finish.
If you are not familiar with the terminal and you use the Claude Desktop app, there is a CodeYam desktop extension instead, with its own video walking through that setup. And if you are new to the terminal and want help with something like creating a new directory, there is a video for that too. This one stays on installing CodeYam in the terminal.
Once the package is added successfully, run codeyam-editor start exactly as it appears, and CodeYam launches.
From there you set up a new project and give it a name, or open one of your existing projects. As a brand-new user you will not have an existing project yet, so you launch CodeYam with a new one.