Skip to content

Commit 0ecabf2

Browse files
committed
chore: update setup with .env.example
1 parent 0bfd53a commit 0ecabf2

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Required
2+
ANTHROPIC_API_KEY=
3+
4+
# Generate at https://github.com/settings/personal-access-tokens
5+
GITHUB_ACCESS_TOKEN=

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.PHONY: chat dev console
22

33
install:
4-
uv sync && uv run pre-commit install
4+
uv sync && uv run pre-commit install && cp .env.example .env && echo "Please edit the .env file with your API keys."
55

66
chat:
77
uv run chat

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,42 @@ This is a less feature-rich Python version of [agent-chat-cli](https://github.co
44

55
https://github.com/user-attachments/assets/66a1d462-e51a-419f-80f3-fa69ee60db9c
66

7-
## Purpose
7+
## Why?
88

9-
This tool is for those who wish for slightly more control over their MCP servers via configurable system prompts, and a minimal terminal-based MCP form factor. (It can do a lot of things thanks to the Claude Agent SDK, but the main purpose, at least for me, is a simple, humble and performant MCP interface to whatever tools I typically use day-to-day.)
9+
This tool is for those who want slightly more control over their MCP servers via configurable system prompts, and a minimal terminal-based MCP form factor for interaction. Many more things are possible thanks to the Claude Agent SDK, but the main purpose, at least for me, is a simple, humble and performant MCP interface to whatever tools I typically use day-to-day.
1010

11-
> Note: The Python version is visually sturdier than the Node.js version. No more crazy terminal flashing like in claude-code!
11+
> Note: The Python version is visually sturdier than the Node.js version. No more crazy terminal flashing like in Claude Code!
1212
1313
## Setup
1414

1515
This app uses [uv](https://github.com/astral-sh/uv) for package management so first install that. Then:
1616

17-
- `git clone https://github.com/damassi/agent-chat-cli-python.git`
18-
- `make install`
19-
- `make chat`
17+
```bash
18+
git clone https://github.com/damassi/agent-chat-cli-python.git
19+
20+
# Install deps and setup .env
21+
make install
22+
```
23+
24+
Update the `.env` with your `ANTHROPIC_API_KEY` and then run:
25+
26+
```bash
27+
make chat
28+
29+
# Alternatively, if in dev (see below)
30+
make dev
31+
```
2032

2133
Additional MCP servers are configured in `agent-chat-cli.config.yaml` and prompts added within the `prompts` folder.
2234

2335
## Development
2436

25-
- Install pre-commit hooks
37+
- Install pre-commit hooks via [pre-commit](https://pre-commit.com/)
2638
- `uv run pre-commit install`
2739
- Typechecking is via [MyPy](https://github.com/python/mypy):
2840
- `uv run mypy src`
2941
- Linting and formatting is via [Ruff](https://docs.astral.sh/ruff/)
42+
- `uv run ruff check src`
3043

3144
Textual has an integrated logging console which one can boot separately from the app to receive logs.
3245

@@ -38,7 +51,7 @@ make console
3851

3952
> Note: this command intentionally filters out more verbose notifications. See the Makefile to configure.
4053
41-
And then in a second, start the textual dev server:
54+
And then, in a second terminal pane, start the textual dev server:
4255

4356
```bash
4457
make dev

0 commit comments

Comments
 (0)