AgentSeek

https://ob-labs.github.io/agentseek/
Admin
AgentSeek is a lifecycle toolkit and CLI that provides a consistent local development workflow for...
Tokens:23,105
Snippets:213
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Project Creation Output

Source: https://ob-labs.github.io/agentseek/guides/create-project

Example output showing the generated directory and recommended next steps.

```text
Created my_bub_agent

Next:
  cd my_bub_agent
  agentseek info
  agentseek task --list
  agentseek doctor
```

--------------------------------

### Lifecycle configuration example

Source: https://ob-labs.github.io/agentseek/guides/run-local-development

An excerpt from .agentseek/lifecycle.toml showing process and service declarations that define the startup plan.

```toml
[processes.gateway]
command = ["uv", "run", "bub", "gateway", "--enable-channel", "ag-ui"]

[processes.frontend]
command = ["npm", "run", "dev"]
cwd = "frontend"

[services.app]
url = "http://127.0.0.1:5173"
```

--------------------------------

### Run readiness check and start dev server

Source: https://ob-labs.github.io/agentseek/get-started

Runs the readiness check with 'agentseek doctor' and starts the development server with 'agentseek dev'. Use Ctrl+C to stop the local development stack.

```bash
agentseek doctor
agentseek dev
```

--------------------------------

### Install AgentSeek CLI with uv tool install

Source: https://ob-labs.github.io/agentseek/get-started

Installs the AgentSeek CLI globally using uv. Requires uv to be installed on the system.

```bash
uv tool install agentseek
```

--------------------------------

### Lifecycle v1 TOML example

Source: https://ob-labs.github.io/agentseek/reference/lifecycle-spec

Complete example of a version 1 lifecycle file with template, name, env_file, tools, paths, env variables, services, processes, checks, and tasks.

```toml
version = 1
template = "bub/default"
name = "My Bub Agent"
env_file = ".env"

[tools]
required = ["uv", "node", "npm"]

[paths]
required = ["frontend/package.json", "frontend/node_modules"]

[env.BUB_MODEL]
required = true
default = "openai:gpt-4o-mini"

[env.BUB_API_KEY]
required = true
aliases = ["BUB_OPENAI_API_KEY"]

[services.app]
url = "http://127.0.0.1:5173"

[processes.frontend]
command = ["npm", "run", "dev"]
cwd = "frontend"

[checks.frontend]
type = "http"
target = "http://127.0.0.1:5173"
timeout = 2
attempts = 3

[tasks.frontend]
description = "Install frontend dependencies."
command = ["npm", "install", "--prefix", "frontend"]
```

--------------------------------

### .agentseek/lifecycle.toml excerpt

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Example lifecycle configuration file defining service URLs for app, gateway, and copilotkit.

```toml
[services.app]
url = "http://127.0.0.1:5173"

[services.gateway]
url = "http://127.0.0.1:8088/agent"

[services.copilotkit]
url = "http://127.0.0.1:4000/api/copilotkit"

```

--------------------------------

### agentseek info --verbose output excerpt

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Example verbose output showing capabilities and discovery paths for Python, uv, node, and npm.

```text
Capabilities
  commands: dev, info, doctor
  tasks: frontend

Discovery
  Python: /path/to/python
  uv: /path/to/uv
  node: /path/to/node
  npm: /path/to/npm

```

--------------------------------

### Create and run a Bub template project

Source: https://ob-labs.github.io/agentseek

Walks through creating a Bub template project, setting up the environment, listing and running tasks, checking readiness, and starting the dev stack. Fill .env before running agentseek doctor; otherwise the readiness check reports missing credentials.

```bash
agentseek create bub/default --no-input
cd my_bub_agent
cp .env.example .env
$EDITOR .env
agentseek task --list
agentseek task frontend
agentseek doctor
agentseek dev

```

--------------------------------

### Start the development stack

Source: https://ob-labs.github.io/agentseek/guides/run-local-development

Launches the development stack from the project directory. It is recommended to run agentseek doctor first to ensure the environment is ready.

```bash
agentseek dev
```

--------------------------------

### Run agentseek info --verbose

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Use verbose mode to get loader details such as capabilities and discovery paths.

```bash
agentseek info --verbose

```

--------------------------------

### agentseek info output excerpt

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Example output from `agentseek info` showing project root, name, template, lifecycle version, entry points, environment, and lifecycle tasks.

```text
Project
  Root: /path/to/my_bub_agent
  Name: My Bub Agent
  Template: bub/default
  Lifecycle: .agentseek/lifecycle.toml / version 2

Entrypoints
  Dev: agentseek dev
  App: http://127.0.0.1:5173
  Gateway: http://127.0.0.1:8088/agent
  Copilotkit: http://127.0.0.1:4000/api/copilotkit

Environment
  Env file: .env (present)
  BUB_MODEL: set (.env)
  BUB_API_KEY: set (.env)

Lifecycle Tasks
  frontend: Install frontend dependencies.

Next
  agentseek task --list
  agentseek doctor
  agentseek dev

```

--------------------------------

### Install OceanBase seekdb skills via npx

Source: https://ob-labs.github.io/agentseek/guides/run-project-tasks

Command executed by the `seekdb-skills` task to install the OceanBase seekdb ecology plugins. Requires Node.js with `npx` and network access to the npm registry and skill pack repository.

```bash
npx skills add oceanbase/seekdb-ecology-plugins --all

```

--------------------------------

### agentseek info --json pretty-printed excerpt

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Example pretty-printed JSON output from `agentseek info --json` showing schema version, services, and actions.

```json
{
  "schema_version": 1,
  "command": "info",
  "ok": true,
  "lifecycle_version": 2,
  "data": {
    "metadata_complete": true,
    "services": [
      {
        "id": "app",
        "name": "Application",
        "kind": "web",
        "display": "default",
        "primary": true
      }
    ],
    "actions": [
      {
        "id": "service:app:open",
        "type": "open_url",
        "label": "Open Application",
        "service_id": "app",
        "url": "http://127.0.0.1:5173"
      }
    ]
  },
  "error": null
}

```

--------------------------------

### Run agentseek doctor --live and view output

Source: https://ob-labs.github.io/agentseek/guides/check-project

Run the doctor in live mode after starting the app. It checks whether local services are listening and prints reachable health endpoints.

```bash
agentseek doctor --live

```

```text
ok   gateway: http://127.0.0.1:8088/agent/health is reachable.
ok   copilotkit: http://127.0.0.1:4000/health is reachable.
ok   frontend: http://127.0.0.1:5173 is reachable.

```

--------------------------------

### Lifecycle configuration in .agentseek/lifecycle.toml

Source: https://ob-labs.github.io/agentseek/guides/create-template

Defines the required tools, environment variables, services, processes, checks, and tasks for the generated application. The `sync` task installs Python dependencies, and all long-running processes must be placed under `[processes.*]`.

```toml
version = 2
template = "langchain/my-template"
name = "{{ cookiecutter.project_name }}"
description = "LangChain example application."
env_file = ".env"
guide = "README.md"

[tools]
required = ["uv"]

[env.AGENTSEEK_MODEL]
required = true
default = "{{ cookiecutter.default_model }}"
description = "Chat model used by the generated agent."

[services.backend]
name = "LangGraph API"
url = "http://127.0.0.1:2024"
kind = "api"
display = "default"
primary = true
description = "Local API used by the generated application."
links = { docs = "https://docs.langchain.com/oss/python/langgraph/overview" }

[processes.backend]
command = ["uv", "run", "python", "-m", "{{ cookiecutter.project_slug }}.server"]

[checks.backend]
type = "http"
target = "http://127.0.0.1:2024"
timeout = 2
attempts = 3
service = "backend"

[tasks.sync]
description = "Install Python dependencies."
command = ["uv", "sync"]
```

--------------------------------

### Run optional seekdb-skills task

Source: https://ob-labs.github.io/agentseek/guides/run-project-tasks

Runs the optional `seekdb-skills` task exposed by seekdb-heavy templates. This task installs recommended OceanBase seekdb skills for supported coding agents. Requires Node.js with `npx`, network access, and a supported coding agent.

```bash
agentseek task seekdb-skills

```

--------------------------------

### .env.example configuration

Source: https://ob-labs.github.io/agentseek/guides/create-template

An excerpt of the .env.example file for standardizing provider configuration.

```text
AGENTSEEK_MODEL={{ cookiecutter.default_model }}
AGENTSEEK_API_KEY=
AGENTSEEK_API_BASE=
```

--------------------------------

### Prepare project environment and run frontend task

Source: https://ob-labs.github.io/agentseek/get-started

Copies the .env.example file to .env, opens it in the default editor, lists available tasks, and runs the 'frontend' task. Set the model and provider credentials in .env or the environment. For non-dry-run 'agentseek dev', the project env_file is read once and reused as an immutable snapshot; one-shot tasks do not inherit env_file.

```bash
cp .env.example .env
$EDITOR .env
agentseek task --list
agentseek task frontend
```

--------------------------------

### Preview startup plan

Source: https://ob-labs.github.io/agentseek/guides/run-local-development

Displays the startup plan without launching any services. This command shows the configured processes, frontend commands, and service URLs.

```bash
agentseek dev --dry-run
```

```text
Startup plan
  Gateway: uv run bub gateway --enable-channel ag-ui
  Frontend: npm run dev
  App: http://127.0.0.1:5173
  Gateway: http://127.0.0.1:8088/agent
  Copilotkit: http://127.0.0.1:4000/api/copilotkit
```

--------------------------------

### Run agentseek dev with dry-run

Source: https://ob-labs.github.io/agentseek/guides/local-execution-modes

Previews the startup plan without actually launching any processes.

```bash
agentseek dev --dry-run
```

--------------------------------

### Lifecycle file discovery path

Source: https://ob-labs.github.io/agentseek/reference/lifecycle-spec

Shows the path AgentSeek searches for the lifecycle spec, starting from the current directory and moving upward.

```text
.agentseek/lifecycle.toml
```

--------------------------------

### List All Templates

Source: https://ob-labs.github.io/agentseek/guides/create-project

List all available templates using the CLI.

```bash
agentseek create --list-templates
```

--------------------------------

### Start development without doctor check

Source: https://ob-labs.github.io/agentseek/guides/run-local-development

Launches the development stack while skipping the preliminary doctor check. Core lifecycle requirements are still enforced.

```bash
agentseek dev --skip-check
```

--------------------------------

### Create a Project with Template

Source: https://ob-labs.github.io/agentseek/guides/create-project

Create a new project using the specified template path without interactive input.

```bash
agentseek create bub/default --no-input
```

--------------------------------

### Run agentseek info

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Run the `info` command from the project directory to display project details, entry points, environment, and lifecycle tasks.

```bash
agentseek info

```

--------------------------------

### Create an AgentSeek app from template

Source: https://ob-labs.github.io/agentseek/get-started

Creates a new app from the 'bub/default' template without prompting, then changes into the generated 'my_bub_agent' directory. Other templates use the same lifecycle commands.

```bash
agentseek create bub/default --no-input
cd my_bub_agent
```

--------------------------------

### Change Directory

Source: https://ob-labs.github.io/agentseek/guides/create-project

Navigate into the newly generated project directory.

```bash
cd my_bub_agent
```

--------------------------------

### Enable Phoenix in Hybrid Template

Source: https://ob-labs.github.io/agentseek/guides/observability-tracing

Run this command to opt-in to Phoenix, then configure the environment variables for local development.

```bash
agentseek task phoenix
```

```bash
AGENTSEEK_OTEL_ENABLED=true
AGENTSEEK_OTEL_SERVICE_NAME=<project-slug>
AGENTSEEK_OTEL_PROJECT_NAME=<project-slug>
AGENTSEEK_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://127.0.0.1:6006/v1/traces
```

--------------------------------

### Run agentseek doctor and view default output

Source: https://ob-labs.github.io/agentseek/guides/check-project

Run the default readiness check from the project directory. The output lists each check with an 'ok' prefix when it passes. Prepare .env and run 'agentseek task frontend' first when you expect a passing check.

```bash
agentseek doctor

```

```text
ok   lifecycle.toml: Lifecycle spec is present.
ok   uv: uv is available.
ok   node: node is available.
ok   npm: npm is available.
ok   frontend/package.json: frontend/package.json is present.
ok   frontend/node_modules: frontend/node_modules is present.
ok   .env: .env is present.
ok   BUB_MODEL: BUB_MODEL is configured.
ok   BUB_API_KEY: BUB_API_KEY or BUB_OPENAI_API_KEY is configured.
ok   gateway cwd: . is present.
ok   frontend cwd: frontend is present.

```

--------------------------------

### Compatibility Template Command

Source: https://ob-labs.github.io/agentseek/guides/create-project

Legacy entry point for listing templates.

```bash
agentseek create --template
```

--------------------------------

### List public templates

Source: https://ob-labs.github.io/agentseek/guides/create-template

Use this command to list all available public templates.

```bash
uv run agentseek create --list-templates
```

--------------------------------

### Create Project with Explicit Template

Source: https://ob-labs.github.io/agentseek/guides/create-project

Create a project by specifying the template type and name.

```bash
agentseek create bub --template default --no-input
```

--------------------------------

### Render a local template with agentseek create

Source: https://ob-labs.github.io/agentseek/guides/create-template

Sets the template spec to a checked-in template, creates an empty output directory, and renders the template from the absolute local path with Cookiecutter defaults. Run these commands in order to generate a project from the local template.

```bash
export TEMPLATE_SPEC=langchain/agentic-rag

```

```bash
export TEMPLATE_OUTPUT="$(mktemp -d)"

```

```bash
uv run agentseek create "$PWD/templates/$TEMPLATE_SPEC" --no-input --output-dir "$TEMPLATE_OUTPUT"

```

--------------------------------

### Run agentseek info --json

Source: https://ob-labs.github.io/agentseek/guides/inspect-project

Use JSON mode when another program needs stable service topology and actions.

```bash
agentseek info --json

```

--------------------------------

### AgentSeek CLI workflow overview

Source: https://ob-labs.github.io/agentseek

Shows the high-level flow from the AgentSeek CLI through the app template to the editable generated app, then to lifecycle tasks and the local development stack.

```text
AgentSeek CLI
  -> app template
    -> editable generated app
      -> lifecycle tasks
      -> local development stack

```

--------------------------------

### Run agentseek task commands

Source: https://ob-labs.github.io/agentseek/guides/local-execution-modes

Lists available tasks or executes a specific task defined by the template.

```bash
agentseek task --list
agentseek task frontend
```

--------------------------------

### Configure Phoenix for Localhost

Source: https://ob-labs.github.io/agentseek/guides/observability-tracing

Point the OTLP traces endpoint to localhost for non-compose runs.

```bash
AGENTSEEK_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://127.0.0.1:6006/v1/traces
```

--------------------------------

### List project tasks with agentseek task --list

Source: https://ob-labs.github.io/agentseek/guides/run-project-tasks

Lists all tasks exposed by the generated project. The output shows task names and descriptions, sourced from `[tasks.*]` entries in the lifecycle spec.

```bash
agentseek task --list

```

```text
  frontend              Install frontend dependencies.

```

--------------------------------

### Run agentseek doctor

Source: https://ob-labs.github.io/agentseek/guides/local-execution-modes

Use this command to perform a standard readiness check on the project.

```bash
agentseek doctor
```
Tokens:
Raw