Skip to content

Commit 8be014e

Browse files
authored
Merge pull request #33 from elizaOS/docs/elizaos-capitalization
Docs/elizaos capitalization
2 parents a192c20 + 95dd9d8 commit 8be014e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+769
-207
lines changed

cli-reference/agent.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Agent Command
3-
description: Managing ElizaOS agents through the CLI - list, configure, start, stop, and update agents
3+
description: Managing elizaOS agents through the CLI - list, configure, start, stop, and update agents
44
icon: robot
55
---
66

cli-reference/create.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ icon: circle-plus
127127

128128
### Project (Default)
129129

130-
Creates a complete ElizaOS project with:
130+
Creates a complete elizaOS project with:
131131

132132
- Agent configuration and character files
133133
- Knowledge directory for RAG
@@ -151,7 +151,7 @@ icon: circle-plus
151151

152152
### Plugin
153153

154-
Creates a plugin that extends ElizaOS functionality:
154+
Creates a plugin that extends elizaOS functionality:
155155

156156
```bash
157157
elizaos create -t plugin my-plugin

cli-reference/dev.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Development Mode
3-
description: Run ElizaOS projects in development mode with hot reloading and debugging
3+
description: Run elizaOS projects in development mode with hot reloading and debugging
44
icon: code
55
---
66

@@ -88,7 +88,7 @@ icon: code
8888

8989
### Project Detection
9090

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

cli-reference/env.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Environment Configuration
3-
description: Configure environment variables and API keys for ElizaOS projects
3+
description: Configure environment variables and API keys for elizaOS projects
44
icon: gear
55
---
66

@@ -125,7 +125,7 @@ icon: gear
125125

126126
## Environment File Structure
127127

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

131131
### Missing .env File Handling

cli-reference/monorepo.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Monorepo Command
3-
description: Clone the ElizaOS monorepo for development or contribution
3+
description: Clone the elizaOS monorepo for development or contribution
44
icon: code-branch
55
---
66

@@ -107,7 +107,7 @@ The cloned repository includes:
107107
```
108108
eliza/
109109
├── packages/
110-
│ ├── core/ # Core ElizaOS functionality
110+
│ ├── core/ # Core elizaOS functionality
111111
│ ├── client-web/ # Web interface
112112
│ ├── client-discord/ # Discord client
113113
│ ├── plugin-*/ # Various plugins

cli-reference/overview.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: ElizaOS CLI Overview
3-
description: Comprehensive guide to the ElizaOS Command Line Interface (CLI) tools and commands
2+
title: elizaOS CLI Overview
3+
description: Comprehensive guide to the elizaOS Command Line Interface (CLI) tools and commands
44
icon: terminal
55
---
66

77
## Installation
88

9-
Install the ElizaOS CLI globally using Bun:
9+
Install the elizaOS CLI globally using Bun:
1010

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

7676
## Development vs Production
7777

78-
ElizaOS supports two main modes of operation:
78+
elizaOS supports two main modes of operation:
7979

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

8989
## Quick Start
9090

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

9393
### Creating a new project
9494

@@ -119,7 +119,7 @@ elizaos dev
119119

120120
## Working with Projects
121121

122-
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:
122+
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:
123123

124124
1. **Create** a new project with `create`
125125
2. **Configure** settings with `env`
@@ -150,7 +150,7 @@ elizaos publish --test
150150

151151
<CardGroup cols={2}>
152152
<Card title="Quickstart Guide" icon="rocket" href="/quickstart">
153-
Complete workflow guide to get started with ElizaOS
153+
Complete workflow guide to get started with elizaOS
154154
</Card>
155155
<Card title="Environment Configuration" icon="gear" href="/cli-reference/env">
156156
Managing environment variables and configuration

cli-reference/plugins.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Plugin Management
3-
description: Manage ElizaOS plugins within a project - list, add, remove
3+
description: Manage elizaOS plugins within a project - list, add, remove
44
icon: plug
55
---
66

@@ -284,15 +284,15 @@ icon: plug
284284

285285
## AI-Powered Plugin Development
286286

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

289289
### Plugin Generation
290290

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

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

297297
### Plugin Migration
298298

cli-reference/publish.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Publish Command
3-
description: Publish a plugin to npm, create a GitHub repository, and submit to the ElizaOS registry
3+
description: Publish a plugin to npm, create a GitHub repository, and submit to the elizaOS registry
44
icon: cloud-arrow-up
55
---
66

7-
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.
7+
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.
88

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

2020
## Usage
2121

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

142-
The ElizaOS registry automatically detects new npm versions.
142+
The elizaOS registry automatically detects new npm versions.
143143
</Tab>
144144

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

214214
<Note>
215-
The `agentConfig` section tells ElizaOS agents how to load your plugin.
215+
The `agentConfig` section tells elizaOS agents how to load your plugin.
216216
</Note>
217217
</Tab>
218218

cli-reference/start.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Start Command
3-
description: Launch and manage ElizaOS projects and agents in production mode
3+
description: Launch and manage elizaOS projects and agents in production mode
44
icon: play
55
---
66

@@ -95,7 +95,7 @@ icon: play
9595
<Tab title="Features">
9696
## Production Features
9797

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

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

106106
## Startup Process
107107

108-
When you run the `start` command, ElizaOS:
108+
When you run the `start` command, elizaOS:
109109

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

120120
## Project Detection
121121

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

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

128128
## Configuration Management
@@ -153,7 +153,7 @@ icon: play
153153
### From .env File
154154

155155
```bash
156-
# ElizaOS looks for .env in the project directory
156+
# elizaOS looks for .env in the project directory
157157
cd my-project
158158
elizaos start # Loads from ./my-project/.env
159159
```
@@ -172,7 +172,7 @@ icon: play
172172

173173
### Character Loading Errors
174174

175-
If character files fail to load, ElizaOS will:
175+
If character files fail to load, elizaOS will:
176176

177177
1. **Log Errors**: Display detailed error messages for each failed character
178178
2. **Continue Starting**: Use any successfully loaded characters

cli-reference/tee.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: TEE Command
3-
description: Manage TEE deployments on ElizaOS
3+
description: Manage TEE deployments on elizaOS
44
icon: shield
55
---
66

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

2727
### Phala Cloud
2828

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

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

106106
### TEE Agent Deployment
107107

108-
For deploying ElizaOS agents to TEE environments:
108+
For deploying elizaOS agents to TEE environments:
109109

110110
1. First, create a TEE-compatible project:
111111

@@ -190,7 +190,7 @@ For detailed output when troubleshooting:
190190
LOG_LEVEL=debug elizaos tee phala cvms list
191191
```
192192

193-
## Integration with ElizaOS
193+
## Integration with elizaOS
194194

195195
TEE deployments enable:
196196

0 commit comments

Comments
 (0)