Files
opencode/docs/USER_GUIDE.md
T
Artur Do Lago 0aa693ba3f refactor: remove hardcoded paths and add upstream merge protection
Code changes:
- Add Global.Path.source getter with AGENT_CORE_SOURCE env var support
- Update status.ts to use Global.Path.source for script paths
- Update setup.ts to use Global.Path.source for docker-compose lookup

Documentation updates:
- Remove hardcoded ~/.local/src/agent-core paths from all docs
- Use generic or relative path references throughout
- README.md, CLAUDE.md, OPS.md, USER_GUIDE.md, PROVIDERS.md updated

Upstream merge protection:
- Add .gitattributes with merge=ours for fork-specific files
- Configure ours merge driver
- Protects: README.md, CONTRIBUTING.md, CLAUDE.md, language READMEs, docs

Deleted (fork cleanup):
- README.zh-CN.md (Chinese Simplified)
- README.zh-TW.md (Chinese Traditional)
- CONTRIBUTING.md
2026-01-20 13:16:31 +01:00

2.3 KiB

Agent-Core User Guide

Welcome to Agent-Core, the engine behind the Personas system (Zee, Stanley, Johny). This guide will get you from "zero" to "fully operational AI assistant".

1. Installation

Prerequisites

  • Docker Desktop (or Docker Engine + Compose)
  • Bun (v1.1+) or Node.js

Install

# Clone the repo
git clone https://github.com/yourusername/agent-core.git

# Install dependencies and build
cd agent-core
./install

2. Setup Infrastructure

Agent-Core relies on Qdrant for long-term memory. We provide a one-command setup:

agent-core setup

This will:

  1. Check for Docker.
  2. Spin up the Qdrant database container.
  3. Verify connection.

3. Configuration

Authentication

You need an LLM provider (Anthropic is recommended for best results).

agent-core auth login

Select "Anthropic" or "OpenAI" and paste your API key.

Personas

Agent-Core comes with three built-in personas:

  • Zee: Your personal assistant (Calendar, Tasks, Memory).
  • Stanley: Financial research (requires the stanley repository).
  • Johny: Learning and Knowledge graphs.

4. Usage

Interactive Mode (TUI)

Start the Terminal User Interface:

agent-core

Type your request. For example:

"Zee, remind me to check the server logs tomorrow at 9am."

Using Personas

You can route requests to specific personas:

"Stanley, what is the P/E ratio of NVDA?"

"Johny, explain the concept of eigenvectors."

Daemon Mode

To run Agent-Core in the background (required for external tools like the Mobile App or WhatsApp gateway):

agent-core daemon

5. Troubleshooting

Diagnostics

If something isn't working:

agent-core debug status

Bug Report

To generate a zip file with logs for support:

agent-core bug-report

Logs

Logs are stored in ~/.local/state/agent-core/logs/. The system keeps the last 5 sessions automatically.

6. Advanced: Connecting Stanley

To unlock the full power of the Investment Persona:

  1. Clone the Stanley repo to ~/Repositories/personas/stanley.
  2. Set up the Python environment there (pip install -r requirements.txt).
  3. Agent-Core will automatically detect the CLI.

Run agent-core and ask:

"Stanley, status" To verify the connection.