Build with the agent of your choice.
Any AI helper works with AgentUI — ChatGPT, Claude, you name it. You don't need to write code or learn the technical bits. Just chat with your AI, and it does the rest.
Hi! I want to start using AgentUI but I'm not a developer. Please help me set it up, in plain English. 1. Check if Node.js 22 or newer is installed on my computer. If not, help me install it. 2. Install the AgentUI CLI by running: npm install -g @agentuiai/cli 3. Confirm it installed by running: agentui --version 4. Log me in by running: agentui auth login — it will email me a 6-digit code that I'll share with you. 5. Ask me which AgentUI project I want to open, then run: agentui project sync <project-id> After each command, explain what just happened in simple words — no jargon. If something fails, troubleshoot it with me patiently. Thanks!
Paste this into your AI. It does the rest.
Open ChatGPT, Claude, or any AI chat. Copy the message below, paste it, and your AI will walk you through everything — install, login, and your first project. No technical background required.
Hi! I want to start using AgentUI but I'm not a developer. Please help me set it up, in plain English. 1. Check if Node.js 22 or newer is installed on my computer. If not, help me install it. 2. Install the AgentUI CLI by running: npm install -g @agentuiai/cli 3. Confirm it installed by running: agentui --version 4. Log me in by running: agentui auth login — it will email me a 6-digit code that I'll share with you. 5. Ask me which AgentUI project I want to open, then run: agentui project sync <project-id> After each command, explain what just happened in simple words — no jargon. If something fails, troubleshoot it with me patiently. Thanks!
Bring your own AI
Claude Code, Cursor, Aider, Codex, your own custom agent. AgentUI doesn't care which AI assistant you run locally — the CLI gives them all the same clean interface to read, edit, and ship AgentUI projects.
Your AI does the work
You stay in the chat. Your AI handles every step — installing, signing in, syncing your project, making changes. You describe what you want in your own words, and your AI does the typing.
Install. Login. Done.
Three commands and your agent is in. No SDK to wire, no API surface to learn — point any AI at the CLI and it can read, write, and ship AgentUI projects.
Three simple steps to get started
Paste the message into your AI
Open ChatGPT, Claude, or any AI chat you already use. Paste the message you copied above and hit send.
Check your email for a code
Your AI will ask for a 6-digit code that we email you. Copy it from your inbox, share it back in the chat — that's the whole login.
Tell your AI what to build
Describe what you need in plain words — "add a customer list," "build a checkout form," whatever you have in mind. Your AI takes care of the rest.
Whether you use ChatGPT, Claude, Cursor, or any other AI helper, they all work the same way with AgentUI. Pick whichever one you're already comfortable chatting with.
Built so anyone can ship — even if you've never opened a terminal
Your AI installs everything for you. No setup wizards, no manuals to read.
If something goes wrong, your AI knows what happened and how to fix it — in plain language.
Every change is previewed before it ships. Nothing surprises you, nothing breaks behind your back.
Your projects stay safe. Your AI can never touch the wrong workspace by accident.
Every command returns JSON, so your agent can run it
Add --json to any command and the output comes back as structured JSON on stdout, errors included — the same approach the AWS and GitHub CLIs take. Your agent runs a command, reads the result and picks the next step, with no one copying output off the screen.
| Command | What it does |
|---|---|
agentui --json project create --name "<name>" | Create the project and its local folder in one step |
agentui --json project list | List projects with their id, type and status |
agentui --json project sync <id> | Pull an existing app to disk as plain files |
agentui --json project diff | See what changed locally |
agentui --json project push --dry-run | Print exactly what a push would send |
agentui --json functions invoke <id> | Run a backend function and read the result |
agentui --json functions logs <stepId> | Read a function's execution logs |
agentui --json integrations list | See which integrations the account can already reach |
agentui --json secrets list | See which credentials exist, never their values |
agentui --json validate | Check the project for errors before you ship it |
agentui --json deploy | Ship a built project |
Every flag, exit code and troubleshooting step is in the README on npm. Open the README
Reading this as an AI assistant? The whole command surface is one flat markdown file: /agentui-cli.md
What your agent can't do with these commands
Worth reading before you give an agent access to your production apps.
Secret values never leave the server — not in secrets list, not in a sync bundle. Your agent uses a credential without ever seeing it.
Path traversal is rejected on every read, write and delete, so a command can't reach files outside the project folder.
A push is capped at 50 operations and 1 MB, and --dry-run prints the exact changes before anything is sent.
Every request is checked against your company. A request for another company's project gets a 404, not a 403, so it doesn't even confirm that project exists.
Questions about the CLI
Do I need an SDK to connect my agent?
No. Install the package, let your agent run shell commands, and point it at /agentui-cli.md so it knows every command without guessing. Claude Code, Codex, Cursor and Aider all work this way.
What does the CLI need, and what does it cost?
Node.js 22 or newer on macOS, Linux or Windows. The CLI is MIT-licensed and free to install, and you sign in with the same account as your AgentUI workspace.
Can I keep my app in git and edit it in VS Code?
Yes. project sync writes your pages, components, functions and entity schemas to disk as .jsx and .schema.json files. project push compares your folder with a local manifest and sends only the difference.
Can I start a brand-new app from the terminal?
Yes. project create --name "My App" creates the project in your workspace and sets up the local folder in one step. Use project sync only for an app that already exists.
Open a terminal. Let the agent build.
Free to install. Same login as your AgentUI workspace. Pair it with the AI of your choice.
npm install -g @agentuiai/cliFree to install · Same login as your AgentUI account · Works with the AI you already use