Skip to content

Update README.md for improved clarity and accuracy in usage instructions and dependencies #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
colinmakerofthings merged 1 commit into from
Feb 26, 2026
Merged

Update README.md for improved clarity and accuracy in usage instructions and dependencies #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
<!-- badges: start -->
![Python Version](https://img.shields.io/badge/python-3.9%2B-blue)
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-d7ff64.svg)
![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)
![Linter: ruff](https://img.shields.io/badge/linter-ruff-d7ff64.svg)
![Security: ruff](https://img.shields.io/badge/security-ruff%20S-orange)
<!-- badges: end -->

Expand All @@ -13,24 +14,29 @@ A Python CLI tool for analyzing logs using the GitHub Copilot SDK.

- Accepts logs from a single file or a directory (combined analysis)
- Supports plain text and JSON log formats
- Accurate token counting via [tiktoken](https://github.com/openai/tiktoken) (cl100k_base / GPT-4 compatible), with a character-based fallback
- Large logs chunked automatically to stay within the model's context window
- Uses Copilot SDK for LLM-powered analysis

## Usage (MVP)

```sh
python -m logpilot.cli analyze <path> [OPTIONS]
python -m logpilot.cli [--version] analyze <path> [OPTIONS]
```

### Global Options

- `--version` : Show the current logpilot version and exit

### Arguments

- `<path>`: Path to a log file or directory (any extension)

### Options

- `--version` : Show the current logpilot version and exit
- `--format [auto|json|text]` : Log format (default: auto)
- `--output [text|json]` : Output type (default: text)
- `--max-tokens <int>` : Max tokens per chunk (default: 2048)
- `--max-tokens <int>` : Max tokens per chunk (default: 2048). Token counts are measured using tiktoken (cl100k_base encoding). Increase this value for larger context windows or decrease it to stay within tighter model limits.
- `--out-file <path>` : Write output to file (default: stdout)
- `--recursive` : Recurse into subdirectories (directory mode)
- `--include <glob>` : Glob pattern(s) to include (repeatable)
Expand Down Expand Up @@ -77,8 +83,12 @@ python -m logpilot.cli analyze mylog.txt --model gpt-3.5-turbo
## Requirements

- Python 3.9+
- Typer
- rich
- [Typer](https://typer.tiangolo.com/) — CLI framework
- [rich](https://github.com/Textualize/rich) — terminal output formatting
- [tiktoken](https://github.com/openai/tiktoken) — accurate token counting (cl100k_base)
- [tqdm](https://github.com/tqdm/tqdm) — progress bars
- [orjson](https://github.com/ijl/orjson) — fast JSON parsing
- [toml](https://github.com/uiri/toml) — TOML config parsing (Python < 3.11 fallback)
- GitHub Copilot SDK

## Supported Platforms
Expand Down