rumo-cli 0.1.0__tar.gz

rumo_cli-0.1.0/.gitignore

@@ -0,0 +1,3 @@
+.venv/
+__pycache__/
+*.egg-info/

rumo_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pedro Buzzi Filho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rumo_cli-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.5
+Name: rumo-cli
+Version: 0.1.0
+Summary: Your dev work, past, now and later: Markdown files, a terminal Timeline, and AI agents that keep it current
+Project-URL: Homepage, https://github.com/pedrobuzzi/rumo
+Project-URL: Issues, https://github.com/pedrobuzzi/rumo/issues
+Author: Pedro Buzzi
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai-agents,claude-code,markdown,productivity,tasks,todo,tui,worklog
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: textual>=1.0
+Description-Content-Type: text/markdown
+
+# rumo
+
+**Your work, past, now and later.** rumo is a local, file-based organizer for a developer's own
+work. Every piece of work is a Markdown file on your machine. Run `rumo` to see it all as a
+Timeline, and let your AI agent sessions keep it up to date while you work.
+
+![rumo Timeline](docs/timeline.svg)
+
+- **Now**: what you are doing or waiting on, with the next step of each item.
+- **Past**: what you finished in the last two weeks (answers "what did I do?" for a standup).
+- **Later**: ideas and paused work, so nothing you meant to do gets lost.
+
+Items can belong to a **group** (an initiative): the title takes the group color and the footer
+shows a legend. The interface is in English; the content (titles, notes, steps) is in your own
+language.
+
+Nothing leaves your machine. There is no server, no database and no sync with Jira or ClickUp
+(ask your agent to update those if you want).
+
+## Install
+
+**1. The `rumo` command** (pick one):
+
+```bash
+uv tool install rumo-cli            # macOS, Linux, Windows (https://docs.astral.sh/uv/)
+pipx install rumo-cli               # macOS, Linux, Windows
+brew install pedrobuzzi/tap/rumo    # macOS, Linux
+```
+
+Then run `rumo`. The first run creates `~/rumo/` for your items and a config file with your
+system language.
+
+**2. Your AI agent** (optional, but this is where rumo shines):
+
+- **Claude Code**, full experience (the agent keeps linked items up to date):
+
+  ```
+  /plugin marketplace add pedrobuzzi/rumo
+  /plugin install rumo@rumo
+  ```
+
+- **Codex, Gemini CLI, Cursor, GitHub Copilot and other agents** that read `SKILL.md` files,
+  simple mode (create items and ideas, list and search them; no automatic updates):
+
+  ```bash
+  npx skills add pedrobuzzi/rumo
+  ```
+
+**Update**: `uv tool upgrade rumo-cli` (or `pipx upgrade rumo-cli`, `brew upgrade rumo`), and
+`/plugin marketplace update rumo` in Claude Code.
+
+**Uninstall**: `/plugin uninstall rumo@rumo`, then `uv tool uninstall rumo-cli` (or
+`pipx uninstall rumo-cli`, `brew uninstall rumo`). Your items in `~/rumo/` are never touched.
+
+## Use
+
+**In the terminal**: `rumo` opens the Timeline.
+
+| Key | Action |
+|---|---|
+| ↑ ↓ | move through the Timeline |
+| Tab | switch between Timeline, steps and sessions |
+| `s` | change status (1-5 picks directly) |
+| `g` | set the group, or create a new one with a color |
+| `t` | toggle tags |
+| `n` | capture a new idea |
+| `e` | open the item in `$EDITOR` |
+| space | check or uncheck the selected step |
+| `c` | copy the command that resumes the selected agent session |
+| `/` | filter by title, tag, group or text (Esc clears) |
+| `q` | quit |
+
+**In an agent session**: type `/rumo` for a menu that fits the moment, or go straight to:
+
+| Command | What it does |
+|---|---|
+| `/rumo new` | Track this session's work as an item. Looks for a similar idea first and offers to promote it. |
+| `/rumo idea <text>` | Note something for later without leaving the topic. |
+| `/rumo link [item]` | Continue an existing item in this session. |
+| `/rumo now` | List what is in progress, with the next step of each. |
+| `/rumo find <text>` | Search past, current and future items. |
+| `/rumo status` | Show where you left off on the linked item. |
+| `/rumo step <text>` | Add a step to the linked item. |
+| `/rumo park [reason]` | Pause the item with an accurate "Left off" and stop updating it here. |
+| `/rumo done` | Finish the item (checks the steps, asks first). |
+| `/rumo unlink` | Stop updating the item from this session. |
+
+`link`, `status`, `step`, `park` and `unlink` need Claude Code with the plugin, because they rely on
+its session id and hook. Other agents get the rest.
+
+When you create an item or an idea, the agent checks whether it belongs to an existing group. If
+other ungrouped items look like the same initiative, it suggests a new group (name and color) and
+applies it only if you agree.
+
+While a session is linked, the agent updates the item after every response in which something
+changed. `/clear` starts a new, unlinked session; `claude --resume <id>` picks the old one up again.
+
+## Item format
+
+```markdown
+---
+title: Redirect after logout
+status: doing
+group: auth
+tags: [bug, frontend]
+created: 2026-10-11 10:08
+updated: 2026-10-11 16:30
+---
+
+## Left off
+Point the redirect to the home page; the e2e test is still missing.
+
+## Context
+Users land on a protected page after logging out.
+
+## Steps
+- [x] [agent] Fix the logout handler
+- [ ] [manual] Ask for a PR review
+- [ ] [agent] e2e test for logout
+
+## Sessions
+- 2026-10-11 10:08 | web-app (main) | 7134aad0-4ba6-4583-9503-c08e98d28270 | /Users/you/repo/web-app
+```
+
+- Statuses: `idea`, `doing`, `waiting`, `paused`, `done`. `done: <date>` is set when an item is finished.
+- Steps are `[agent]` (the AI can do it) or `[manual]` (you or someone else does it).
+- An idea can be just the frontmatter; it grows when you start working on it.
+- A session line ending in `| closed` no longer updates the item.
+
+## Config
+
+`config.toml` lives in `~/.config/rumo/` on macOS and Linux (or `$XDG_CONFIG_HOME/rumo/`) and in
+`%APPDATA%\rumo\` on Windows. `rumo index` prints its path.
+
+```toml
+folder = "~/rumo"
+language = "pt-BR"     # language of the content the agent writes; defaults to your system language
+tags = ["bug", "feature", "refactor", "research", "spike", "review",
+        "infra", "deploy", "meeting", "docs", "support", "tech-debt"]
+
+[groups.auth]
+name = "Auth migration"
+color = "blue"         # blue, green, yellow, orange, red, magenta, purple, cyan
+```
+
+`RUMO_DIR` and `RUMO_CONFIG` override the folder and the config path.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the layout, tests, trying the plugin locally and how
+releases work.
+
+## License
+
+[MIT](LICENSE)

rumo_cli-0.1.0/README.md

@@ -0,0 +1,155 @@
+# rumo
+
+**Your work, past, now and later.** rumo is a local, file-based organizer for a developer's own
+work. Every piece of work is a Markdown file on your machine. Run `rumo` to see it all as a
+Timeline, and let your AI agent sessions keep it up to date while you work.
+
+![rumo Timeline](docs/timeline.svg)
+
+- **Now**: what you are doing or waiting on, with the next step of each item.
+- **Past**: what you finished in the last two weeks (answers "what did I do?" for a standup).
+- **Later**: ideas and paused work, so nothing you meant to do gets lost.
+
+Items can belong to a **group** (an initiative): the title takes the group color and the footer
+shows a legend. The interface is in English; the content (titles, notes, steps) is in your own
+language.
+
+Nothing leaves your machine. There is no server, no database and no sync with Jira or ClickUp
+(ask your agent to update those if you want).
+
+## Install
+
+**1. The `rumo` command** (pick one):
+
+```bash
+uv tool install rumo-cli            # macOS, Linux, Windows (https://docs.astral.sh/uv/)
+pipx install rumo-cli               # macOS, Linux, Windows
+brew install pedrobuzzi/tap/rumo    # macOS, Linux
+```
+
+Then run `rumo`. The first run creates `~/rumo/` for your items and a config file with your
+system language.
+
+**2. Your AI agent** (optional, but this is where rumo shines):
+
+- **Claude Code**, full experience (the agent keeps linked items up to date):
+
+  ```
+  /plugin marketplace add pedrobuzzi/rumo
+  /plugin install rumo@rumo
+  ```
+
+- **Codex, Gemini CLI, Cursor, GitHub Copilot and other agents** that read `SKILL.md` files,
+  simple mode (create items and ideas, list and search them; no automatic updates):
+
+  ```bash
+  npx skills add pedrobuzzi/rumo
+  ```
+
+**Update**: `uv tool upgrade rumo-cli` (or `pipx upgrade rumo-cli`, `brew upgrade rumo`), and
+`/plugin marketplace update rumo` in Claude Code.
+
+**Uninstall**: `/plugin uninstall rumo@rumo`, then `uv tool uninstall rumo-cli` (or
+`pipx uninstall rumo-cli`, `brew uninstall rumo`). Your items in `~/rumo/` are never touched.
+
+## Use
+
+**In the terminal**: `rumo` opens the Timeline.
+
+| Key | Action |
+|---|---|
+| ↑ ↓ | move through the Timeline |
+| Tab | switch between Timeline, steps and sessions |
+| `s` | change status (1-5 picks directly) |
+| `g` | set the group, or create a new one with a color |
+| `t` | toggle tags |
+| `n` | capture a new idea |
+| `e` | open the item in `$EDITOR` |
+| space | check or uncheck the selected step |
+| `c` | copy the command that resumes the selected agent session |
+| `/` | filter by title, tag, group or text (Esc clears) |
+| `q` | quit |
+
+**In an agent session**: type `/rumo` for a menu that fits the moment, or go straight to:
+
+| Command | What it does |
+|---|---|
+| `/rumo new` | Track this session's work as an item. Looks for a similar idea first and offers to promote it. |
+| `/rumo idea <text>` | Note something for later without leaving the topic. |
+| `/rumo link [item]` | Continue an existing item in this session. |
+| `/rumo now` | List what is in progress, with the next step of each. |
+| `/rumo find <text>` | Search past, current and future items. |
+| `/rumo status` | Show where you left off on the linked item. |
+| `/rumo step <text>` | Add a step to the linked item. |
+| `/rumo park [reason]` | Pause the item with an accurate "Left off" and stop updating it here. |
+| `/rumo done` | Finish the item (checks the steps, asks first). |
+| `/rumo unlink` | Stop updating the item from this session. |
+
+`link`, `status`, `step`, `park` and `unlink` need Claude Code with the plugin, because they rely on
+its session id and hook. Other agents get the rest.
+
+When you create an item or an idea, the agent checks whether it belongs to an existing group. If
+other ungrouped items look like the same initiative, it suggests a new group (name and color) and
+applies it only if you agree.
+
+While a session is linked, the agent updates the item after every response in which something
+changed. `/clear` starts a new, unlinked session; `claude --resume <id>` picks the old one up again.
+
+## Item format
+
+```markdown
+---
+title: Redirect after logout
+status: doing
+group: auth
+tags: [bug, frontend]
+created: 2026-10-11 10:08
+updated: 2026-10-11 16:30
+---
+
+## Left off
+Point the redirect to the home page; the e2e test is still missing.
+
+## Context
+Users land on a protected page after logging out.
+
+## Steps
+- [x] [agent] Fix the logout handler
+- [ ] [manual] Ask for a PR review
+- [ ] [agent] e2e test for logout
+
+## Sessions
+- 2026-10-11 10:08 | web-app (main) | 7134aad0-4ba6-4583-9503-c08e98d28270 | /Users/you/repo/web-app
+```
+
+- Statuses: `idea`, `doing`, `waiting`, `paused`, `done`. `done: <date>` is set when an item is finished.
+- Steps are `[agent]` (the AI can do it) or `[manual]` (you or someone else does it).
+- An idea can be just the frontmatter; it grows when you start working on it.
+- A session line ending in `| closed` no longer updates the item.
+
+## Config
+
+`config.toml` lives in `~/.config/rumo/` on macOS and Linux (or `$XDG_CONFIG_HOME/rumo/`) and in
+`%APPDATA%\rumo\` on Windows. `rumo index` prints its path.
+
+```toml
+folder = "~/rumo"
+language = "pt-BR"     # language of the content the agent writes; defaults to your system language
+tags = ["bug", "feature", "refactor", "research", "spike", "review",
+        "infra", "deploy", "meeting", "docs", "support", "tech-debt"]
+
+[groups.auth]
+name = "Auth migration"
+color = "blue"         # blue, green, yellow, orange, red, magenta, purple, cyan
+```
+
+`RUMO_DIR` and `RUMO_CONFIG` override the folder and the config path.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the layout, tests, trying the plugin locally and how
+releases work.
+
+## License
+
+[MIT](LICENSE)

rumo_cli-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "rumo-cli"
+version = "0.1.0"
+description = "Your dev work, past, now and later: Markdown files, a terminal Timeline, and AI agents that keep it current"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Pedro Buzzi" }]
+keywords = ["productivity", "tasks", "todo", "worklog", "markdown", "tui", "claude-code", "ai-agents"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Office/Business :: Scheduling",
+    "Topic :: Utilities",
+]
+dependencies = ["textual>=1.0"]
+
+[project.urls]
+Homepage = "https://github.com/pedrobuzzi/rumo"
+Issues = "https://github.com/pedrobuzzi/rumo/issues"
+
+[project.scripts]
+rumo = "rumo.cli:main"
+
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rumo"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/rumo", "README.md", "LICENSE"]
+
+[tool.pyright]
+include = ["src", "tests", "scripts"]
+pythonVersion = "3.11"