Skip to content

Commit 2930254

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

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
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: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,38 @@ https://github.com/user-attachments/assets/66a1d462-e51a-419f-80f3-fa69ee60db9c
66

77
## Purpose
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+
make install
20+
```
21+
22+
Update the `.env` with your `ANTHROPIC_API_KEY` and then run:
23+
24+
```bash
25+
make chat
26+
27+
# Alternatively, if in dev (see below)
28+
make dev
29+
```
2030

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

2333
## Development
2434

25-
- Install pre-commit hooks
35+
- Install pre-commit hooks via [pre-commit](https://pre-commit.com/)
2636
- `uv run pre-commit install`
2737
- Typechecking is via [MyPy](https://github.com/python/mypy):
2838
- `uv run mypy src`
2939
- Linting and formatting is via [Ruff](https://docs.astral.sh/ruff/)
40+
- `uv run ruff check src`
3041

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

@@ -38,7 +49,7 @@ make console
3849

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

4354
```bash
4455
make dev

0 commit comments

Comments
 (0)