Skip to main content

Getting Started

b1e55ed is a CLI-first trading intelligence engine built around append-only events. This guide covers a local first run.

Install

Setup wizard

Running from source? Use ./b1e55ed wizard or uv run b1e55ed wizard instead.

Prerequisites

  • Python 3.11+
  • uv
  • SQLite (bundled on most systems)
Recommended:
  • A dedicated B1E55ED_MASTER_PASSWORD for encrypted-at-rest identity and keystore material.

Install

After install, b1e55ed is available globally in your PATH.

Option B: From source

From-source users can use ./b1e55ed (repo wrapper) or uv run b1e55ed for all commands.1

Quick start (local)

Sequence: install → forge identity → setup → register contributor → run brain.

1) Forge an identity (The Forge)

The Forge derives an Ethereum identity with a 0xb1e55ed prefix. Required if you plan to use EAS attestations.
Outputs:
  • .b1e55ed/identity.json (public identity)
  • .b1e55ed/forge_key.enc (private key material; protect it)
If you are not using EAS attestations, forging is optional.

2) Run setup

Setup writes config/user.yaml, initializes data/brain.db, and stores secrets in the keystore when available.

3) (Optional) Configure EAS

EAS is used to create and verify off-chain attestations for contributors. Edit config/user.yaml:
See: eas-integration.md.

4) Register a contributor

Contributors are the attribution unit for signals. Register via CLI:
If EAS is enabled and eas.attester_private_key is configured:
See: contributors.md.

5) Run the brain

Ingest your first signal:
See: curator.md for the full curator pipeline.

6) Start API + dashboard

API requires api.auth_token unless B1E55ED_INSECURE_OK=1 is set.
Check agent interfaces:
This returns MCP tools, event domains, and producer capability summaries for onboarding.

Cockpit

After setup, visit the cockpit for a “what do I trade today” view:
The cockpit shows top convictions, current regime, kill switch status, and recent P&L. Refreshes every 30 seconds via HTMX.

Reports

Next steps

Footnotes

  1. From-source: use ./b1e55ed command or uv run b1e55ed command. Installed users: just b1e55ed command.