https://github.com/jac18281828/parsm
Parsm is a structured data processor written in Rust
https://github.com/jac18281828/parsm
awk csv dsl filter grep json parser sed text toml yaml
Last synced: 24 days ago
JSON representation
Parsm is a structured data processor written in Rust
- Host: GitHub
- URL: https://github.com/jac18281828/parsm
- Owner: jac18281828
- License: mit
- Created: 2025-06-05T23:11:16.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-11-20T03:30:14.000Z (4 months ago)
- Last Synced: 2025-11-20T05:25:50.173Z (4 months ago)
- Topics: awk, csv, dsl, filter, grep, json, parser, sed, text, toml, yaml
- Language: Rust
- Homepage:
- Size: 1020 KB
- Stars: 10
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# parsm - **Parse 'Em** - An 'everything' parser, Sedder, Awkker, Grokker, Grepper
Parsm is the powerful command-line tool that understands structured text better than `sed`, `awk`, `grep` or `grok`.
## Overview
`parsm` automatically detects and parses multiple data formats (**JSON**, **CSV**, **YAML**, **TOML**, **logfmt**, and plain text) and provides powerful filtering and templating capabilities through an intuitive syntax.
By default, parsm outputs the original input when a filter matches. For custom output formatting, use templates.
## Installation
### From crates.io
```bash
cargo install parsm
```
### From source
```bash
cargo install --path .
```
Or build from source:
```bash
git clone
cd parsm
cargo build --release
./target/release/parsm --examples
```
## Quick Start
```bash
# Basic usage
parsm [FILTER] [TEMPLATE]
# Examples
parsm --examples
# Extract a field
echo '{"name": "Alice"}' | parsm 'name'
# Nested fields
echo '{"user": {"email": "alice@example.com"}}' | parsm 'user.email'
# Filtering
echo '{"age": 30}' | parsm 'age > 25'
# Filter and format
echo '{"name": "Alice", "age": 30}' | parsm 'age > 25 [${name} is ${age}]'
```
## Supported Formats
- JSON
- CSV
- YAML
- TOML
- Logfmt
- Plain Text
## Syntax Reference
### Filters
- Comparison: `==`, `!=`, `<`, `<=`, `>`, `>=`
- String ops: `*=` (contains), `^=` (starts with), `$=` (ends with), `~=` (regex match)
- Boolean logic: `&&`, `||`, `!`
- **Truthy** check: `field?`
Examples:
```bash
name == "Alice" && age > 25
email ~ "@example.com"
user.active?
```
### Templates
- Variables: `[${name}]` or `$name`
- Literal: `[name]`
Example:
```bash
parsm 'age > 25 [${name} is ${age}]'
```
### Field Selectors
- Simple: `name`
- Nested: `user.email`
- Quoted (special chars): `'special-field'`
- CSV/Text: `field_0`, `word_0`
## Examples
### JSON/YAML/TOML
```bash
cat Cargo.toml | parsm 'package.name'
echo '{"user": {"email": "alice@example.com"}}' | parsm 'user.email'
```
### CSV
```bash
echo 'Alice,30,Engineer' | parsm 'field_1 > "25" [${1} (${2})]'
```
### Logs
```bash
echo 'level=error msg="DB error"' | parsm 'level == "error" [${msg}]'
```
## CLI
```bash
parsm [OPTIONS] [FILTER] [TEMPLATE]
Arguments:
[FILTER] Filter expression (optional)
[TEMPLATE] Template expression for output formatting (optional)
Options:
--examples Show usage examples
--json Force JSON format detection
--yaml Force YAML format detection
--csv Force CSV format detection
--toml Force TOML format detection
--logfmt Force logfmt format detection
--text Force plain text format detection
-h, --help Print help
-V, --version Print version
```
## Comparison with Other Tools
| Feature | parsm | jq | awk | sed |
|------------------|-------------|------------|------------|------------|
| Multi-format | ✅ JSON, CSV, YAML, TOML, logfmt, text | JSON only | Text | Text |
| Auto-detection | ✅ Automatic | ❌ Manual | ❌ Manual | ❌ Manual |
| Field extraction | ✅ Simple `name` syntax | ✅ `.name` syntax | Limited | ❌ No |
| Simple syntax | ✅ Low | Medium | Complex | Medium |
## Development
- Build: `cargo build`
- Test: `cargo test`
- Lint: `cargo fmt && cargo clippy`
## Contributing
1. Fork repository
2. Create feature branch
3. Write tests and code
4. Run tests and lint checks
5. Submit a pull request
## Crates.io
[crates.io](https://crates.io/crates/parsm)
[docs.rs](https://docs.rs/parsm)
## License
See [LICENSE](LICENSE).
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
## Examples
```bash
# Basic filtering - outputs original input when filter matches
echo '{"name": "Alice", "age": 30}' | parsm 'age > 25'
# Output: {"name": "Alice", "age": 30}
# Filtering with custom template
echo '{"name": "Alice", "age": 30}' | parsm 'age > 25 [${name} is ${age}]'
# Output: Alice is 30
# Access original input in templates with ${0}
echo '{"name": "Alice", "age": 30}' | parsm '[Original: ${0}, Name: ${name}]'
# Output: Original: {"name": "Alice", "age": 30}, Name: Alice
```