Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli-reference/agent.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Agent Command
description: Managing ElizaOS agents through the CLI - list, configure, start, stop, and update agents
description: Managing elizaOS agents through the CLI - list, configure, start, stop, and update agents
icon: robot
---

Expand Down
4 changes: 2 additions & 2 deletions cli-reference/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ icon: circle-plus

### Project (Default)

Creates a complete ElizaOS project with:
Creates a complete elizaOS project with:

- Agent configuration and character files
- Knowledge directory for RAG
Expand All @@ -151,7 +151,7 @@ icon: circle-plus

### Plugin

Creates a plugin that extends ElizaOS functionality:
Creates a plugin that extends elizaOS functionality:

```bash
elizaos create -t plugin my-plugin
Expand Down
4 changes: 2 additions & 2 deletions cli-reference/dev.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Development Mode
description: Run ElizaOS projects in development mode with hot reloading and debugging
description: Run elizaOS projects in development mode with hot reloading and debugging
icon: code
---

Expand Down Expand Up @@ -88,7 +88,7 @@ icon: code

### Project Detection

- **Project Mode**: Automatically detects Eliza projects based on package.json configuration
- **Project Mode**: Automatically detects elizaOS projects based on package.json configuration
- **Plugin Mode**: Detects and handles plugin development appropriately
- **Monorepo Support**: Builds core packages when working in monorepo context

Expand Down
4 changes: 2 additions & 2 deletions cli-reference/env.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Environment Configuration
description: Configure environment variables and API keys for ElizaOS projects
description: Configure environment variables and API keys for elizaOS projects
icon: gear
---

Expand Down Expand Up @@ -125,7 +125,7 @@ icon: gear

## Environment File Structure

ElizaOS uses local environment variables stored in `.env` files in your project directory:
elizaOS uses local environment variables stored in `.env` files in your project directory:
- **Local variables** - Stored in `./.env` in your current project directory

### Missing .env File Handling
Expand Down
4 changes: 2 additions & 2 deletions cli-reference/monorepo.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Monorepo Command
description: Clone the ElizaOS monorepo for development or contribution
description: Clone the elizaOS monorepo for development or contribution
icon: code-branch
---

Expand Down Expand Up @@ -107,7 +107,7 @@ The cloned repository includes:
```
eliza/
├── packages/
│ ├── core/ # Core ElizaOS functionality
│ ├── core/ # Core elizaOS functionality
│ ├── client-web/ # Web interface
│ ├── client-discord/ # Discord client
│ ├── plugin-*/ # Various plugins
Expand Down
22 changes: 11 additions & 11 deletions cli-reference/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: ElizaOS CLI Overview
description: Comprehensive guide to the ElizaOS Command Line Interface (CLI) tools and commands
title: elizaOS CLI Overview
description: Comprehensive guide to the elizaOS Command Line Interface (CLI) tools and commands
icon: terminal
---

## Installation

Install the ElizaOS CLI globally using Bun:
Install the elizaOS CLI globally using Bun:

```bash
bun install -g @elizaos/cli
Expand All @@ -17,12 +17,12 @@ bun install -g @elizaos/cli
| Command | Description |
| ------- | ----------- |
| [`create`](/cli-reference/create) | Initialize a new project, plugin, or agent |
| [`monorepo`](/cli-reference/monorepo) | Clone ElizaOS monorepo from a specific branch (defaults to develop) |
| [`plugins`](/cli-reference/plugins) | Manage ElizaOS plugins |
| [`agent`](/cli-reference/agent) | Manage ElizaOS agents |
| [`monorepo`](/cli-reference/monorepo) | Clone elizaOS monorepo from a specific branch (defaults to develop) |
| [`plugins`](/cli-reference/plugins) | Manage elizaOS plugins |
| [`agent`](/cli-reference/agent) | Manage elizaOS agents |
| [`tee`](/cli-reference/tee) | Manage TEE deployments |
| [`start`](/cli-reference/start) | Start the Eliza agent with configurable plugins and services |
| [`update`](/cli-reference/update) | Update ElizaOS CLI and project dependencies |
| [`update`](/cli-reference/update) | Update elizaOS CLI and project dependencies |
| [`test`](/cli-reference/test) | Run tests for Eliza agent projects and plugins |
| [`env`](/cli-reference/env) | Manage environment variables and secrets |
| [`dev`](/cli-reference/dev) | Start the project or plugin in development mode with auto-rebuild, detailed logging, and file change detection |
Expand Down Expand Up @@ -75,7 +75,7 @@ elizaos env interactive

## Development vs Production

ElizaOS supports two main modes of operation:
elizaOS supports two main modes of operation:

<CardGroup cols={2}>
<Card title="Development Mode" icon="code" href="/cli-reference/dev">
Expand All @@ -88,7 +88,7 @@ ElizaOS supports two main modes of operation:

## Quick Start

For a complete guide to getting started with ElizaOS, see the [Quickstart Guide](/quickstart).
For a complete guide to getting started with elizaOS, see the [Quickstart Guide](/quickstart).

### Creating a new project

Expand Down Expand Up @@ -119,7 +119,7 @@ elizaos dev

## Working with Projects

ElizaOS organizes work into projects, which can contain one or more agents along with their configurations, knowledge files, and dependencies. The CLI provides commands to manage the entire lifecycle of a project:
elizaOS organizes work into projects, which can contain one or more agents along with their configurations, knowledge files, and dependencies. The CLI provides commands to manage the entire lifecycle of a project:

1. **Create** a new project with `create`
2. **Configure** settings with `env`
Expand Down Expand Up @@ -150,7 +150,7 @@ elizaos publish --test

<CardGroup cols={2}>
<Card title="Quickstart Guide" icon="rocket" href="/quickstart">
Complete workflow guide to get started with ElizaOS
Complete workflow guide to get started with elizaOS
</Card>
<Card title="Environment Configuration" icon="gear" href="/cli-reference/env">
Managing environment variables and configuration
Expand Down
6 changes: 3 additions & 3 deletions cli-reference/plugins.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Plugin Management
description: Manage ElizaOS plugins within a project - list, add, remove
description: Manage elizaOS plugins within a project - list, add, remove
icon: plug
---

Expand Down Expand Up @@ -284,15 +284,15 @@ icon: plug

## AI-Powered Plugin Development

ElizaOS includes AI-powered features to help with plugin development:
elizaOS includes AI-powered features to help with plugin development:

### Plugin Generation

The `generate` command uses AI to create a new plugin based on your specifications:

1. **Interactive Mode**: Guides you through plugin requirements
2. **Code Generation**: Creates complete plugin structure with actions, providers, and tests
3. **Validation**: Ensures generated code follows ElizaOS best practices
3. **Validation**: Ensures generated code follows elizaOS best practices

### Plugin Migration

Expand Down
12 changes: 6 additions & 6 deletions cli-reference/publish.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Publish Command
description: Publish a plugin to npm, create a GitHub repository, and submit to the ElizaOS registry
description: Publish a plugin to npm, create a GitHub repository, and submit to the elizaOS registry
icon: cloud-arrow-up
---

The `elizaos publish` command is the all-in-one tool for releasing your plugin. It handles packaging, publishing to npm, creating a source repository, and submitting your plugin to the official ElizaOS registry for discovery.
The `elizaos publish` command is the all-in-one tool for releasing your plugin. It handles packaging, publishing to npm, creating a source repository, and submitting your plugin to the official elizaOS registry for discovery.

<Tabs>
<Tab title="Overview">
Expand All @@ -15,7 +15,7 @@ The `elizaos publish` command is the all-in-one tool for releasing your plugin.
- **Validates Your Plugin:** Checks your `package.json` and directory structure against registry requirements
- **Publishes Your Package:** Pushes your plugin to npm
- **Creates GitHub Repository:** Initializes a public GitHub repository for your plugin's source code
- **Submits to Registry:** Opens a Pull Request to the official [ElizaOS Plugin Registry](https://github.com/elizaos-plugins/registry)
- **Submits to Registry:** Opens a Pull Request to the official [elizaOS Plugin Registry](https://github.com/elizaos-plugins/registry)

## Usage

Expand Down Expand Up @@ -139,7 +139,7 @@ The `elizaos publish` command is the all-in-one tool for releasing your plugin.
git push && git push --tags
```

The ElizaOS registry automatically detects new npm versions.
The elizaOS registry automatically detects new npm versions.
</Tab>

<Tab title="Requirements">
Expand Down Expand Up @@ -182,7 +182,7 @@ The `elizaos publish` command is the all-in-one tool for releasing your plugin.
{
"name": "plugin-example",
"version": "1.0.0",
"description": "An example ElizaOS plugin that demonstrates best practices",
"description": "An example elizaOS plugin that demonstrates best practices",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"author": "Your Name <your.email@example.com>",
Expand Down Expand Up @@ -212,7 +212,7 @@ The `elizaos publish` command is the all-in-one tool for releasing your plugin.
```

<Note>
The `agentConfig` section tells ElizaOS agents how to load your plugin.
The `agentConfig` section tells elizaOS agents how to load your plugin.
</Note>
</Tab>

Expand Down
16 changes: 8 additions & 8 deletions cli-reference/start.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Start Command
description: Launch and manage ElizaOS projects and agents in production mode
description: Launch and manage elizaOS projects and agents in production mode
icon: play
---

Expand Down Expand Up @@ -95,7 +95,7 @@ icon: play
<Tab title="Features">
## Production Features

When you run `start`, ElizaOS provides production-ready features:
When you run `start`, elizaOS provides production-ready features:

1. **Optimized Performance**: Runs with production optimizations
2. **Stable Configuration**: Uses saved configuration by default
Expand All @@ -105,7 +105,7 @@ icon: play

## Startup Process

When you run the `start` command, ElizaOS:
When you run the `start` command, elizaOS:

1. **Project Detection**: Detects whether you're in a project or plugin directory
2. **Configuration Loading**: Loads and validates the configuration
Expand All @@ -119,10 +119,10 @@ icon: play

## Project Detection

ElizaOS automatically detects the type of directory you're in and adjusts its behavior accordingly:
elizaOS automatically detects the type of directory you're in and adjusts its behavior accordingly:

- **ElizaOS Projects**: Loads project configuration and starts defined agents
- **ElizaOS Plugins**: Runs in plugin test mode with the default character
- **elizaOS Projects**: Loads project configuration and starts defined agents
- **elizaOS Plugins**: Runs in plugin test mode with the default character
- **Other Directories**: Uses the default Eliza character

## Configuration Management
Expand Down Expand Up @@ -153,7 +153,7 @@ icon: play
### From .env File

```bash
# ElizaOS looks for .env in the project directory
# elizaOS looks for .env in the project directory
cd my-project
elizaos start # Loads from ./my-project/.env
```
Expand All @@ -172,7 +172,7 @@ icon: play

### Character Loading Errors

If character files fail to load, ElizaOS will:
If character files fail to load, elizaOS will:

1. **Log Errors**: Display detailed error messages for each failed character
2. **Continue Starting**: Use any successfully loaded characters
Expand Down
8 changes: 4 additions & 4 deletions cli-reference/tee.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TEE Command
description: Manage TEE deployments on ElizaOS
description: Manage TEE deployments on elizaOS
icon: shield
---

Expand All @@ -26,7 +26,7 @@ elizaos tee <vendor> [vendor-specific-commands]

### Phala Cloud

The `phala` subcommand provides a wrapper for the official Phala Cloud CLI, allowing you to manage TEE deployments on Phala Cloud directly through ElizaOS.
The `phala` subcommand provides a wrapper for the official Phala Cloud CLI, allowing you to manage TEE deployments on Phala Cloud directly through elizaOS.

```bash
elizaos tee phala [phala-cli-commands]
Expand Down Expand Up @@ -105,7 +105,7 @@ elizaos tee phala nodes get <id> # Get details about a specific node

### TEE Agent Deployment

For deploying ElizaOS agents to TEE environments:
For deploying elizaOS agents to TEE environments:

1. First, create a TEE-compatible project:

Expand Down Expand Up @@ -190,7 +190,7 @@ For detailed output when troubleshooting:
LOG_LEVEL=debug elizaos tee phala cvms list
```

## Integration with ElizaOS
## Integration with elizaOS

TEE deployments enable:

Expand Down
6 changes: 3 additions & 3 deletions cli-reference/test.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Test Command
description: Run and manage tests for ElizaOS projects and plugins
description: Run and manage tests for elizaOS projects and plugins
icon: flask
---

Expand Down Expand Up @@ -91,14 +91,14 @@ icon: flask
### End-to-End Tests

**Location**: `e2e/` directory
**Framework**: Custom ElizaOS test runner
**Framework**: Custom elizaOS test runner
**Purpose**: Runtime behavior testing with full agent context
</Tab>

<Tab title="Writing Tests">
## Test Structure

ElizaOS follows standard testing conventions with two main categories:
elizaOS follows standard testing conventions with two main categories:

### Component Tests (`__tests__/`)

Expand Down
16 changes: 8 additions & 8 deletions cli-reference/update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update Command
description: Update your project's ElizaOS dependencies and CLI to the latest published versions
description: Update your project's elizaOS dependencies and CLI to the latest published versions
icon: arrows-rotate
---

Expand Down Expand Up @@ -46,7 +46,7 @@ icon: arrows-rotate
Current CLI version: 1.3.5
Latest CLI version: 1.4.0

ElizaOS packages that can be updated:
elizaOS packages that can be updated:
- @elizaos/core (1.3.0) → 1.4.0
- @elizaos/plugin-openai (1.2.5) → 1.4.0

Expand Down Expand Up @@ -79,7 +79,7 @@ icon: arrows-rotate

When you run `elizaos update`, it performs the following steps:

1. **Detects Project Type**: Determines if you're in an ElizaOS project or plugin.
1. **Detects Project Type**: Determines if you're in an elizaOS project or plugin.
2. **Checks CLI Version**: Compares your installed CLI version with the latest available on npm.
3. **Scans Dependencies**: Finds all `@elizaos/*` packages in your project's `package.json`.
4. **Shows Update Plan**: Lists the packages and/or CLI that have available updates.
Expand Down Expand Up @@ -107,9 +107,9 @@ icon: arrows-rotate

The update command automatically detects:

- **ElizaOS Projects**: Updates project dependencies and rebuilds
- **ElizaOS Plugins**: Updates plugin dependencies and rebuilds
- **Non-ElizaOS Projects**: Shows error message
- **elizaOS Projects**: Updates project dependencies and rebuilds
- **elizaOS Plugins**: Updates plugin dependencies and rebuilds
- **Non-elizaOS Projects**: Shows error message

## Workspace Support

Expand All @@ -124,7 +124,7 @@ icon: arrows-rotate
```bash
$ elizaos update --check

ElizaOS packages found:
elizaOS packages found:
- @elizaos/core (workspace:*) → Skipped (workspace reference)
- @elizaos/plugin-openai (1.2.5) → 1.4.0
- @elizaos/plugin-discord (workspace:*) → Skipped (workspace reference)
Expand All @@ -138,7 +138,7 @@ icon: arrows-rotate

- Update regularly to get latest features and fixes
- Use `--check` to monitor available updates
- Subscribe to ElizaOS release notes
- Subscribe to elizaOS release notes

### Stability Considerations

Expand Down
Loading