Skip to content

.env.example: say plainly that paper and simulate need a CDP key too — read-only is enough #311

Description

@eaitbrahim

Verified while writing the README quickstart (#300): keel fetch fails with an AuthenticationError when no CDP key is configured — candle history goes through the authenticated client even though it is public data. .env.example currently says nothing about which commands need keys at all.

File to touch: .env.example (the CDP_API_KEY block).

Done looks like: a comment above CDP_API_KEY stating: market-data commands (fetch, simulate, monitor, the agent cycle) need a key even in paper mode; a read-only key is sufficient for all of them; live trading additionally needs a key with trade permission.

How to verify: mv .env .env.bak && uv run keel fetch reproduces the AuthenticationError; restore the file, and the comment predicts exactly that behaviour.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions