Format
Developer toolkit for checking, validating, formatting, linting, converting, and managing code and text entries. All operations are logged with timestamps and stored locally for full traceability.
Commands
| Command |
Usage |
Description |
check |
format check <input> |
Record a check entry or view recent checks |
validate |
format validate <input> |
Record a validation entry or view recent validations |
generate |
format generate <input> |
Record a generate entry or view recent generations |
format |
format format <input> |
Record a format entry or view recent formatting operations |
lint |
format lint <input> |
Record a lint entry or view recent lint results |
explain |
format explain <input> |
Record an explain entry or view recent explanations |
convert |
format convert <input> |
Record a convert entry or view recent conversions |
template |
format template <input> |
Record a template entry or view recent templates |
diff |
format diff <input> |
Record a diff entry or view recent diffs |
preview |
format preview <input> |
Record a preview entry or view recent previews |
fix |
format fix <input> |
Record a fix entry or view recent fixes |
report |
format report <input> |
Record a report entry or view recent reports |
stats |
format stats |
Show summary statistics across all entry types |
export <fmt> |
format export json|csv|txt |
Export all entries to JSON, CSV, or plain text |
search <term> |
format search <term> |
Search across all log files for a keyword |
recent |
format recent |
Show the 20 most recent history entries |
status |
format status |
Health check — version, entry count, disk usage, last activity |
help |
format help |
Show help with all available commands |
version |
format version |
Print version string |
Each command (check, validate, generate, format, lint, explain, convert, template, diff, preview, fix, report) works the same way:
- With arguments: Saves the input with a timestamp to
<command>.log and logs to history.log.
- Without arguments: Displays the 20 most recent entries from
<command>.log.
Data Storage
All data is stored locally at ~/.local/share/format/:
<command>.log — Timestamped entries for each command (e.g., check.log, lint.log)history.log — Unified activity log across all commandsexport.json, export.csv, export.txt — Generated export files
No cloud, no network calls, no external API calls needed. Fully offline.
Requirements
- Bash 4+ (uses
set -euo pipefail)
- Standard Unix utilities (
date, wc, du, grep, head, tail)
- No external dependencies
When to Use
- Logging code review notes — Use
format check or format lint to record issues found during code reviews, keeping a timestamped trail of findings.
- Tracking format and conversion tasks — Use
format convert and format format to log what was converted or reformatted, building an audit trail.
- Generating reports from logged data — Use
format report to record report items, then format export json to extract structured data for dashboards or further processing.
- Searching past operations — Use
format search <term> to find specific entries across all log files when you need to recall what was done previously.
- Monitoring toolkit health — Use
format status to verify the tool is operational, check disk usage, and see when the last activity occurred.
Examples
# Record a check entry
format check "validate JSON schema for config.yaml"
# Record a lint finding
format lint "unused import in main.go line 42"
# View recent format operations (no args = list mode)
format format
# Convert and log the action
format convert "CSV to JSON for user_data.csv"
# Generate a diff note
format diff "comparison between v1.2 and v1.3 API responses"
# Search all logs for a keyword
format search "config"
# Export everything to JSON
format export json
# View summary statistics
format stats
# Health check
format status
# View recent activity
format recent
How It Works
Format stores all data locally in ~/.local/share/format/. Each command logs activity with timestamps in the format YYYY-MM-DD HH:MM|<input>, enabling full traceability. The unified history.log records every operation with MM-DD HH:MM <command>: <input> format for cross-command auditing.
Powered by BytesAgain | bytesagain.com | hello@bytesagain.com
1---2name: format3description: Auto-format source code with language detection, presets, and diff preview. Use when formatting code, enforcing styles, or batch-formatting projects.4license: MIT-05---6
7# Format
8
9Developer toolkit for checking, validating, formatting, linting, converting, and managing code and text entries. All operations are logged with timestamps and stored locally for full traceability.
10
11## Commands
12
13| Command | Usage | Description |
14|---------|-------|-------------|
15| `check` | `format check <input>` | Record a check entry or view recent checks |
16| `validate` | `format validate <input>` | Record a validation entry or view recent validations |
17| `generate` | `format generate <input>` | Record a generate entry or view recent generations |
18| `format` | `format format <input>` | Record a format entry or view recent formatting operations |
19| `lint` | `format lint <input>` | Record a lint entry or view recent lint results |
20| `explain` | `format explain <input>` | Record an explain entry or view recent explanations |
21| `convert` | `format convert <input>` | Record a convert entry or view recent conversions |
22| `template` | `format template <input>` | Record a template entry or view recent templates |
23| `diff` | `format diff <input>` | Record a diff entry or view recent diffs |
24| `preview` | `format preview <input>` | Record a preview entry or view recent previews |
25| `fix` | `format fix <input>` | Record a fix entry or view recent fixes |
26| `report` | `format report <input>` | Record a report entry or view recent reports |
27| `stats` | `format stats` | Show summary statistics across all entry types |
28| `export <fmt>` | `format export json\|csv\|txt` | Export all entries to JSON, CSV, or plain text |
29| `search <term>` | `format search <term>` | Search across all log files for a keyword |
30| `recent` | `format recent` | Show the 20 most recent history entries |
31| `status` | `format status` | Health check — version, entry count, disk usage, last activity |
32| `help` | `format help` | Show help with all available commands |
33| `version` | `format version` | Print version string |
34
35Each command (check, validate, generate, format, lint, explain, convert, template, diff, preview, fix, report) works the same way:
36
37- **With arguments:** Saves the input with a timestamp to `<command>.log` and logs to `history.log`.
38- **Without arguments:** Displays the 20 most recent entries from `<command>.log`.
39
40## Data Storage
41
42All data is stored locally at `~/.local/share/format/`:
43
44- `<command>.log` — Timestamped entries for each command (e.g., `check.log`, `lint.log`)
45- `history.log` — Unified activity log across all commands
46- `export.json`, `export.csv`, `export.txt` — Generated export files
47
48No cloud, no network calls, no external API calls needed. Fully offline.
49
50## Requirements
51
52- Bash 4+ (uses `set -euo pipefail`)
53- Standard Unix utilities (`date`, `wc`, `du`, `grep`, `head`, `tail`)
54- No external dependencies
55
56## When to Use
57
581. **Logging code review notes** — Use `format check` or `format lint` to record issues found during code reviews, keeping a timestamped trail of findings.
592. **Tracking format and conversion tasks** — Use `format convert` and `format format` to log what was converted or reformatted, building an audit trail.
603. **Generating reports from logged data** — Use `format report` to record report items, then `format export json` to extract structured data for dashboards or further processing.
614. **Searching past operations** — Use `format search <term>` to find specific entries across all log files when you need to recall what was done previously.
625. **Monitoring toolkit health** — Use `format status` to verify the tool is operational, check disk usage, and see when the last activity occurred.
63
64## Examples
65
66```bash
67# Record a check entry
68format check "validate JSON schema for config.yaml"
69
70# Record a lint finding
71format lint "unused import in main.go line 42"
72
73# View recent format operations (no args = list mode)
74format format
75
76# Convert and log the action
77format convert "CSV to JSON for user_data.csv"
78
79# Generate a diff note
80format diff "comparison between v1.2 and v1.3 API responses"
81
82# Search all logs for a keyword
83format search "config"
84
85# Export everything to JSON
86format export json
87
88# View summary statistics
89format stats
90
91# Health check
92format status
93
94# View recent activity
95format recent
96```
97
98## How It Works
99
100Format stores all data locally in `~/.local/share/format/`. Each command logs activity with timestamps in the format `YYYY-MM-DD HH:MM|<input>`, enabling full traceability. The unified `history.log` records every operation with `MM-DD HH:MM <command>: <input>` format for cross-command auditing.
101
102---
103
104Powered by BytesAgain | bytesagain.com | hello@bytesagain.com
bytesagain