Skip to content

Commit e871581

Browse files
committed
Add Docker support with workflows and Compose files
Introduced Docker configuration, including a Dockerfile, GitHub Action workflow for automatic builds and pushes, and Docker Compose files for running locally or with prebuilt images. Updated README to document Docker setup and usage options.
1 parent 88ff494 commit e871581

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,26 @@ A beautiful real-time terminal monitoring tool for Claude AI token usage. Track
5858
### Method 1: Docker (Recommended for non-technical users)
5959

6060
**Prerequisites:**
61-
- Docker and Docker Compose installed on your system
61+
- Docker installed on your system
6262

63-
**Super Simple Setup:**
63+
**Option A: One Command (No Download Required!)**
64+
65+
```bash
66+
# Just run this single command:
67+
docker run -it --rm \
68+
-v "$HOME/.claude:/root/.claude:ro" \
69+
-e HOME=/root \
70+
ghcr.io/amphora/claude-code-usage-monitor:docker
71+
72+
# Or with custom options:
73+
docker run -it --rm \
74+
-v "$HOME/.claude:/root/.claude:ro" \
75+
-e HOME=/root \
76+
ghcr.io/amphora/claude-code-usage-monitor:docker \
77+
--plan max5 --timezone US/Eastern
78+
```
79+
80+
**Option B: Using Docker Compose**
6481

6582
```bash
6683
# Clone the repository

run.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/bin/bash
2+
# Claude Code Usage Monitor - Quick Run Script
3+
# Usage: curl -sSL https://raw.githubusercontent.com/amphora/Claude-Code-Usage-Monitor/docker/run.sh | bash
4+
5+
echo "🎯 Starting Claude Code Usage Monitor..."
6+
7+
# Run the Docker container
8+
docker run -it --rm \
9+
-v "$HOME/.claude:/root/.claude:ro" \
10+
-e HOME=/root \
11+
ghcr.io/amphora/claude-code-usage-monitor:docker "$@"

0 commit comments

Comments
 (0)