https://github.com/webpod/jout
Jout reimplements classic Unix tools with JSON output by design
https://github.com/webpod/jout
Last synced: 8 months ago
JSON representation
Jout reimplements classic Unix tools with JSON output by design
- Host: GitHub
- URL: https://github.com/webpod/jout
- Owner: webpod
- License: mit
- Created: 2025-09-06T18:23:06.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-09-07T18:08:14.000Z (9 months ago)
- Last Synced: 2025-09-18T12:15:48.381Z (9 months ago)
- Language: Go
- Size: 22.5 KB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jout
**Jout** reimplements classic Unix utilities with JSON output by design.
Use `jout ls`, `jout ps`, etc., and receive stable, well-defined JSON
that’s safe for scripts, logs, and APIs.
- Familiar subcommands (`ls`, `ps`, …)
- Stable, documented schemas
- ISO 8601 times, byte-accurate sizes
- Works great with [fx](https://fx.wtf) and [jq](https://jqlang.org/)
```bash
# Files as JSON
jout ls /var/log
# Processes as JSON
jout ps --user "$USER"
```
## Tools
- [x] `ls`
- [x] Linux
- [x] Mac
- [x] Windows
- [x] `ps`
- [x] Linux
- [x] Mac
- [x] Windows
- [ ] top
- [ ] pstree
- [ ] ping
- [ ] traceroute
- [ ] nslookup
- [ ] dig
- [ ] host
- [ ] whois
- [ ] ifconfig
- [ ] iwconfig
- [ ] route
- [ ] arp
- [ ] ss
- [ ] hostname
- [ ] mtr
- [ ] df
- [ ] du
## Versioning policy
- We do **not** ship breaking changes; public behavior and JSON schemas remain backward-compatible.
- From **v1.0** onward, JSON schemas are **stable**: no breaking changes within **1.x** (additive changes only).
## Timeline
### v0.x (pre-1.0)
**Focus:** Build out features and stabilize schemas.
**Key work:**
- Expand command set.
- Iterate on and validate JSON schemas.
- Improve docs, and tooling.
### v1.0 (2026)
**Milestone:** JSON schema freeze and stability commitment.
**Outcome:** Applications built against 1.0 schemas continue to work across all **1.x** releases.
### v1.x (2026+)
**Guarantees:**
- No breaking changes to JSON schemas.
- Backward-compatible, additive enhancements (new optional fields/commands, non-breaking defaults).
## License
[MIT](LICENSE)