Metadata-Version: 2.3
Name: logflow-cli
Version: 0.1.7
Summary: Focused developer journaling and ideation loop
License: MIT
Keywords: cli,developer-tools,journaling,productivity
Author: Jay Davis
Author-email: 512jay@gmail.com
Maintainer: Oravox LLC
Maintainer-email: oravoxco@gmail.com
Requires-Python: >=3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: fancy-slugs
Provides-Extra: rich
Provides-Extra: slugify
Requires-Dist: python-slugify (>=8.0.0,<9.0.0) ; extra == "fancy-slugs" or extra == "slugify"
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Requires-Dist: rich (==13.7.1) ; extra == "rich"
Description-Content-Type: text/markdown

# Logflow

[![PyPI version](https://img.shields.io/pypi/v/logflow-cli.svg)](https://pypi.org/project/logflow-cli/)  
[![PyPI - Downloads](https://img.shields.io/pypi/dm/logflow-cli.svg)](https://pypi.org/project/logflow-cli/)  
[![CI](https://github.com/512jay/logflow/actions/workflows/release.yml/badge.svg)](https://github.com/512jay/logflow/actions/workflows/release.yml)  
[![License](https://img.shields.io/github/license/512jay/logflow.svg)](https://github.com/512jay/logflow/blob/main/LICENSE)

[📘 Quickstart Guide](https://github.com/512jay/logflow/blob/main/docs/quickstart.md) – Learn how to install and use Logflow in minutes.

💡 **Tip:** For the best experience, install with extras:

```bash
pipx install logflow-cli[rich,fancy_slugs]
```

This enables rich terminal output and emoji-safe filenames.

---

## 🧠 How Logflow Stores Data

By default, Logflow stores all your developer thoughts in:

```bash
./logflow/
```

This directory includes:

- `daily_logs/` – developer check-ins
- `ideas/` – structured Markdown idea files
- `idea_log.md` – append-only quick thought list
- `completed_log.md` – a snapshot of done ideas
- `next_id.txt` – internal idea counter
- `config.toml` – optional config file

### Example Config:

```toml
[paths]
log_dir = "logflow"
scan_root = "parent"
max_recent_ideas = 5
```

Run `logflow init` to generate this layout and config.

---

Or forcibly regenerate:

```bash
logflow init --force
```

---

## 💡 Use Cases

* Solo dev journaling
* Idea tracking across projects
* Developer time tracking & status reporting
* Task queue for future sprints

---

## 📘 Command Cheat Sheet

```bash
logflow add "Idea"               # Quick log
logflow add "X" --title T --body B --tag TAG

logflow recent                   # Show recent ideas
logflow index                    # Structured idea index

logflow focus                    # Start dev work
logflow status                   # What am I working on?
logflow pause                    # Mark break/end of session

logflow complete 007             # Mark done
logflow delete slug_or_id        # Soft delete
logflow purge                    # Trash cleanup

logflow history --summary        # View logs
logflow init --force             # Regenerate config & folders
logflow help                     # Command list
```

---

## 🎯 Philosophy

Logflow is designed to:

* Work with or without Git
* Require zero setup, but allow full config
* Help developers reflect, prioritize, and focus

It's built for long-term sustainability of developer thought.

---

## 🔓 License

MIT

---

### 📣 Maintained by [Oravox LLC](mailto:oravoxco@gmail.com) — freely available for solo devs, teams, and contributors.

