elizaos--eliza/packages/docs/cli/overview.mdx

---
title: CLI
description: "The elizaos CLI — scaffold, upgrade, deploy."
---

The CLI is intentionally small. It does not manage running agents — your project's `package.json` scripts (`bun run dev`, `bun run build`, `bun run test`) do that. The CLI is for project-level operations: scaffolding, upgrading, deploying, and registry submission.

## Install

```bash
npx elizaos@beta --help
```

Or globally:

```bash
bun add -g elizaos@beta
elizaos --help
```

## Commands

| Command                          | What it does                                                                |
| -------------------------------- | --------------------------------------------------------------------------- |
| `create [name]`                  | Scaffold a new project or plugin from a template.                           |
| `info`                           | Show available project and plugin templates.                                |
| `upgrade`                        | Upgrade the current generated project to the latest template.               |
| `deploy`                         | Deploy the current project to Eliza Cloud (experimental).                   |
| `plugins submit`                 | Submit the current plugin project to the registry.                          |
| `capability-router connect`      | Connect the running agent to a remote capability-router or Cloud sandbox.   |
| `version`                        | Print CLI version.                                                          |

That's the whole surface. There is no `eliza start`, `eliza setup`, `eliza db`, `eliza doctor`, `eliza configure`, `eliza models`, `eliza dashboard`, or `eliza plugins install`. Those are not part of the CLI — they either don't exist, or live in your project's own scripts.

<CardGroup cols={2}>
  <Card title="Create a project" icon="folder-plus" href="/cli/create-project">
    Scaffold a new agent project.
  </Card>
  <Card title="Create a plugin" icon="puzzle-piece" href="/cli/create-plugin">
    Scaffold a new plugin package.
  </Card>
</CardGroup>

## Adding plugins to a project

Plugins are added by editing your character's `plugins` array and running `bun install` to fetch the npm package. There is no `eliza plugins install` command.

```ts
// character.ts
export const character: Character = {
  name: 'Eliza',
  plugins: [
    '@elizaos/plugin-sql',
    '@elizaos/plugin-anthropic',
    '@elizaos/plugin-discord',  // <- add by editing this list
  ],
};
```

```bash
bun add @elizaos/plugin-discord
```

## Source

- CLI: [`packages/elizaos/`](https://github.com/elizaOS/eliza/tree/develop/packages/elizaos)
- Entry: [`packages/elizaos/src/cli.ts`](https://github.com/elizaOS/eliza/blob/develop/packages/elizaos/src/cli.ts)
- Templates: [`packages/elizaos/templates/`](https://github.com/elizaOS/eliza/tree/develop/packages/elizaos/templates)