redo-cli 0.1.0__tar.gz → 0.1.2__tar.gz

redo_cli-0.1.2/PKG-INFO

@@ -0,0 +1,507 @@
+Metadata-Version: 2.4
+Name: redo-cli
+Version: 0.1.2
+Summary: Bookmarks for terminal workflows.
+Author: Vibeslayer-code
+Project-URL: Homepage, https://github.com/VibeSlayer-code/Redo
+Project-URL: Repository, https://github.com/VibeSlayer-code/Redo
+Project-URL: Issues, https://github.com/VibeSlayer-code/Redo/issues
+Keywords: cli,terminal,workflow,automation,developer-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: license.txt
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# Redo
+
+A CLI tool for saving repeated terminal workflows and running them again with one command.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VibeSlayer-code/Redo/main/assets/banner.png" alt="Redo banner" width="100%" />
+</p>
+
+<p align="center">
+  <b>Stop retyping commands. Save workflows once, run them anytime.</b>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/redo-cli/">
+    <img src="https://img.shields.io/pypi/v/redo-cli?style=for-the-badge&label=PyPI" alt="PyPI version">
+  </a>
+  <img src="https://img.shields.io/badge/Python-3.11%2B-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python 3.11+">
+  <img src="https://img.shields.io/badge/CLI-Workflow%20Automation-6D5DFB?style=for-the-badge" alt="CLI Workflow Automation">
+  <img src="https://img.shields.io/badge/Status-Active-22C55E?style=for-the-badge" alt="Active">
+</p>
+
+<p align="center">
+  <a href="#quick-start"><b>Quick Start</b></a>
+  ·
+  <a href="#demo-flow"><b>Demo</b></a>
+  ·
+  <a href="#features"><b>Features</b></a>
+  ·
+  <a href="#commands"><b>Commands</b></a>
+  ·
+  <a href="#local-development"><b>Local Development</b></a>
+</p>
+
+---
+
+## What is Redo?
+
+Redo is a command-line tool that turns repeated terminal command chains into reusable workflows.
+
+Instead of typing this every time:
+
+```bash
+git add .
+git commit -m "fixed bug"
+git push
+```
+
+Save it once:
+
+```bash
+redo new ship
+```
+
+Then run it anytime:
+
+```bash
+redo run ship
+```
+
+Think of Redo as **bookmarks for terminal workflows**.
+
+---
+
+## Demo Flow
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VibeSlayer-code/Redo/main/assets/demo-run.png" alt="Redo demo running workflow" width="85%" />
+</p>
+
+```bash
+redo new ship
+redo list
+redo show ship
+redo run ship --dry
+redo run ship
+redo stats
+```
+
+> Add a real screenshot or GIF at `assets/demo-run.png`.
+> Best shot: the live workflow status table while `redo run ship` is running.
+
+---
+
+## Quick Start
+
+Install from PyPI:
+
+```bash
+pip install redo-cli
+```
+
+Create a workflow:
+
+```bash
+redo new ship
+```
+
+Enter commands one by one:
+
+```txt
+Description: Commit and push code
+Command: git add .
+Command: git commit -m "{message}"
+Command: git push
+Command: :done
+```
+
+Run it later:
+
+```bash
+redo run ship
+```
+
+Preview before running:
+
+```bash
+redo run ship --dry
+```
+
+---
+
+## Why It Matters
+
+Developers repeat command chains constantly:
+
+<table>
+  <tr>
+    <td><b>Project setup</b></td>
+    <td><code>npm install</code>, copy env files, start dev servers</td>
+  </tr>
+  <tr>
+    <td><b>Git workflows</b></td>
+    <td><code>git add</code>, <code>git commit</code>, <code>git push</code></td>
+  </tr>
+  <tr>
+    <td><b>Build flows</b></td>
+    <td>run tests, build apps, deploy projects</td>
+  </tr>
+  <tr>
+    <td><b>Cleanup flows</b></td>
+    <td>remove build folders, reinstall dependencies, reset local state</td>
+  </tr>
+</table>
+
+Redo removes the small friction that adds up over time.
+
+---
+
+## Features
+
+| Feature            | What it does                                       |
+| ------------------ | -------------------------------------------------- |
+| Named workflows    | Save repeated command chains as reusable workflows |
+| One-command replay | Run saved workflows with `redo run <name>`         |
+| Smart placeholders | Use values like `{message}` or `{project_name}`    |
+| Dry run mode       | Preview commands before executing them             |
+| Safety checks      | Detect risky commands before they surprise you     |
+| Focused errors     | Stop on failure and show the command that broke    |
+| Usage stats        | Track run counts and time-saved estimates          |
+| Import/export      | Back up and move workflows between machines        |
+| Doctor/autofix     | Check and repair workflow storage issues           |
+
+---
+
+## Commands
+
+### Core
+
+```bash
+redo init
+redo new <name>
+redo list
+redo show <name>
+redo run <name>
+redo run <name> --dry
+redo delete <name>
+redo stats
+```
+
+### Developer QoL
+
+```bash
+redo search <query>
+redo copy <source> <target>
+redo rename <old-name> <new-name>
+redo path
+redo export workflows-backup.json
+redo import workflows-backup.json
+redo import workflows-backup.json --replace
+redo doctor
+redo autofix
+redo guide
+redo clearhistory
+```
+
+---
+
+## Example Workflow
+
+```bash
+redo new ship
+```
+
+```txt
+Description: Commit and push code
+Command: git add .
+Command: git commit -m "{message}"
+Command: git push
+Command: :done
+```
+
+Saved data:
+
+```json
+{
+  "ship": {
+    "description": "Commit and push code",
+    "commands": [
+      "git add .",
+      "git commit -m \"{message}\"",
+      "git push"
+    ],
+    "runs": 0
+  }
+}
+```
+
+Run it:
+
+```bash
+redo run ship
+```
+
+Redo asks for the placeholder value:
+
+```txt
+message: fixed clumsy ui
+```
+
+Then runs:
+
+```bash
+git add .
+git commit -m "fixed clumsy ui"
+git push
+```
+
+---
+
+## Screenshots
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VibeSlayer-code/Redo/main/assets/list-command.png" alt="Redo list command" width="48%" />
+  <img src="https://raw.githubusercontent.com/VibeSlayer-code/Redo/main/assets/dry-run.png" alt="Redo dry run preview" width="48%" />
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/VibeSlayer-code/Redo/main/assets/error-panel.png" alt="Redo focused error panel" width="85%" />
+</p>
+
+Suggested files to add:
+
+```txt
+assets/banner.png
+assets/demo-run.png
+assets/list-command.png
+assets/dry-run.png
+assets/error-panel.png
+```
+
+For a CLI project, a short terminal GIF is the strongest visual. Recommended GIF:
+
+```txt
+assets/demo.gif
+```
+
+Show this sequence:
+
+```bash
+redo new ship
+redo list
+redo run ship --dry
+redo run ship
+```
+
+Then embed it near the top:
+
+```md
+<p align="center">
+  <img src="assets/demo.gif" alt="Redo terminal demo" width="85%" />
+</p>
+```
+
+---
+
+## Placeholders
+
+Use placeholders when part of a command changes each run.
+
+```bash
+git commit -m "{message}"
+npm create vite@latest {project_name}
+cd {project_name}
+```
+
+Redo asks once for each unique placeholder and replaces every occurrence across the workflow.
+
+Valid placeholder names:
+
+```txt
+{message}
+{project_name}
+{ticket_123}
+```
+
+Invalid placeholder names:
+
+```txt
+{123ticket}
+{project-name}
+{}
+```
+
+Placeholder values are quoted before execution so user input is treated as one literal value instead of shell syntax.
+
+---
+
+## Safety
+
+Redo detects risky commands before running them.
+
+Examples:
+
+```bash
+rm -rf
+del /s
+format
+sudo
+git reset --hard
+```
+
+If a risky command is found, Redo asks for confirmation before continuing.
+
+Use dry-run mode whenever you want to inspect a workflow first:
+
+```bash
+redo run cleanup --dry
+```
+
+---
+
+## Storage
+
+Redo stores workflow data in:
+
+```txt
+%APPDATA%/Redo/workflows.json
+```
+
+If `APPDATA` is unavailable, Redo falls back to:
+
+```txt
+~/.redo/workflows.json
+```
+
+Override the storage directory:
+
+```bash
+REDO_DATA_DIR=<path>
+```
+
+Print the exact storage path:
+
+```bash
+redo path
+```
+
+Repair common storage issues:
+
+```bash
+redo autofix
+```
+
+`redo autofix` can fix missing files, blank files, malformed JSON, and workflow entries with missing fields. If JSON is malformed, Redo saves a non-overwriting `workflows.broken.json` backup before resetting the main file.
+
+---
+
+## Local Development
+
+Requirements:
+
+```txt
+Python 3.11+
+```
+
+Clone the repository:
+
+```bash
+git clone https://github.com/VibeSlayer-code/Redo.git
+cd Redo
+```
+
+Create and activate a virtual environment:
+
+```bash
+python -m venv .venv
+.venv\Scripts\activate
+```
+
+Install dependencies:
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+Run locally:
+
+```bash
+python main.py --help
+redo --help
+redo --info
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+---
+
+## How It Works
+
+Redo is split into small modules instead of one large script.
+
+```txt
+storage.py       workflow JSON storage
+placeholders.py  placeholder detection and replacement
+runner.py        command execution and dry runs
+ui.py            terminal output and tables
+main.py          CLI commands
+```
+
+The workflow lifecycle:
+
+```txt
+load workflow
+process placeholders
+preview or run commands
+stop on failure
+update run count
+```
+
+This keeps the codebase simple while still supporting useful CLI features like dry runs, safety checks, repair tools, and stats.
+
+---
+
+## Roadmap
+
+* Project-local workflow files
+* Shell completion
+* Workflow tags
+* Workflow templates
+* Shared workflows for repositories
+* More detailed time-saved analytics
+* Better safety rules for destructive commands
+
+---
+
+## License
+
+Source-available, all rights reserved.
+
+You may view the source code, but you may not copy, modify, distribute, or use it without permission.