Skip to content
Open
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
4 changes: 2 additions & 2 deletions docs/ROFL_DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Deploy your own private ekai-gateway instance on Oasis Network using ROFL (Runti

```bash
# 1. Clone
git clone https://github.com/ekailabs/ekai-gateway.git
cd ekai-gateway
git clone https://github.com/ekailabs/contexto.git
cd contexto

# 2. Create rofl.yaml from template
cp rofl.yaml.template rofl.yaml
Expand Down
10 changes: 5 additions & 5 deletions docs/USAGE_WITH_CLAUDE_CODE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ This guide shows how to run Claude Code through ekai-gateway for multi‑provide

## Install and Run the Gateway
```bash
git clone https://github.com/ekailabs/ekai-gateway.git
cd ekai-gateway
npm install
npm run dev
git clone https://github.com/ekailabs/contexto.git
cd contexto
pnpm install
pnpm run dev
```

## Configure Environment
Expand Down Expand Up @@ -60,5 +60,5 @@ Notes

## Troubleshooting
- 401/403 errors: verify the relevant API key is present in `.env` and the provider allows the chosen model.
- Connection refused: ensure `npm run dev` is active and `ANTHROPIC_BASE_URL` matches the gateway port.
- Connection refused: ensure `pnpm run dev` is active and `ANTHROPIC_BASE_URL` matches the gateway port.
- Model not found: confirm the model name is supported by its provider and spelled correctly.
10 changes: 5 additions & 5 deletions docs/USAGE_WITH_CODEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ This guide walks through configuring Codex to use ekai-gateway for unified multi

## Install and Run the Gateway
```bash
git clone https://github.com/ekailabs/ekai-gateway.git
cd ekai-gateway
npm install
npm run dev
git clone https://github.com/ekailabs/contexto.git
cd contexto
pnpm install
pnpm run dev
```

## Configure Environment
Expand Down Expand Up @@ -75,4 +75,4 @@ codex --model "claude-sonnet-4-20250514"
## Troubleshooting
- 401/403 errors: ensure the corresponding provider API key is set in `.env` and has access to the selected model.
- 404/Model not found: confirm the model name is supported and correctly spelled.
- Network errors: verify `npm run dev` is running and `OPENAI_BASE_URL`/`base_url` points to the correct port.
- Network errors: verify `pnpm run dev` is running and `OPENAI_BASE_URL`/`base_url` points to the correct port.
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ This is a quick-start for running Ekai Gateway locally. For detailed client setu

1. Clone the repository
```bash
git clone https://github.com/ekailabs/ekai-gateway.git
cd ekai-gateway
git clone https://github.com/ekailabs/contexto.git
cd contexto
```

2. Install dependencies
```bash
npm install
pnpm install
```

3. Copy and edit the environment file
Expand All @@ -42,8 +42,8 @@ This is a quick-start for running Ekai Gateway locally. For detailed client setu

4. Build and start the Gateway
```bash
npm run build
npm start
pnpm run build
pnpm start
```

After startup:
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Ekai is the universal context layer for agentic AI. Below you’ll find quick links to get started and learn more.

[![GitHub - ekailabs/ekai-gateway](https://img.shields.io/badge/GitHub-ekailabs%2Fekai--gateway-181717?logo=github&logoColor=white)](https://github.com/ekailabs/ekai-gateway)
[![GitHub - ekailabs/contexto](https://img.shields.io/badge/GitHub-ekailabs%2Fcontexto-181717?logo=github&logoColor=white)](https://github.com/ekailabs/contexto)

- [Getting Started](getting-started.md)
- [Architecture Overview](architecture-overview.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/memory-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Both use the same `@ekai/memory` engine underneath.
### Install

```bash
npm install @ekai/memory
pnpm add @ekai/memory
```

### SDK Quickstart
Expand Down Expand Up @@ -67,7 +67,7 @@ app.use(createMemoryRouter(memory._store, memory._extractFn));
Run memory as its own HTTP service:

```bash
npm run start -w @ekai/memory
pnpm --filter @ekai/memory run start
# Memory service listening on :4005
```

Expand Down