d2o 0.1.0

Help to Options - Parse help or manpage texts and generate shell completion scripts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

# `d2o`

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
![Version](https://img.shields.io/badge/version-0.1.0-blue)
![License](https://img.shields.io/badge/license-MIT-green)

A high-performance, pure Rust rewrite of h2o - a CLI tool that extracts command-line options from help text and man pages, then exports them as shell completion scripts or JSON.

## Installation

### From Source

```bash
cd /home/muntasir/projects/d2o
cargo build --release
./target/release/d2o --help
```

The release binary will be at `target/release/d2o`

### Pre-compiled Binary

Copy the binary to your PATH:

```bash
cp target/release/d2o ~/.local/bin/
```

### Using Cargo

```bash
cargo install d2o
```

### Using `cargo-binstall`

```bash
cargo binstall d2o
```

Completions are also available for `bash`, `zsh`, `fish`, `powershell`, `elvish` and `nushell`:

```bash
d2o --completions <shell> # Replace <shell> with your shell name
```

Manpages are in tarballs and zips in releases.

## Usage

### Generate shell completion

```shell
# Generate fish completion script from `man ls` or `ls --help`
d2o --command ls --format fish > ls.fish

# Generate zsh completion script
d2o --command git --format zsh > git.zsh

# Generate bash completion script (plain options only)
d2o --command docker --format bash > docker.bash

# Generate bash completion script compatible with bash-completion (includes descriptions)
d2o --command docker --format bash --bash-completion-compat > docker.bash
```

### Export as JSON

```shell
# Export CLI info as JSON
d2o --command ls --format json

# Pretty-print JSON output
d2o --command curl --format json | jq .
```

### Parse local file

```shell
# Save man page to file first
man grep | col -bx > grep.txt

# Parse from file
d2o --file grep.txt --format fish > grep.fish
```

### Advanced options

```shell
# Skip man page lookup (use --help only)
d2o --command cargo --skip-man --format json

# List subcommands
d2o --command git --list-subcommands

# Extract subcommand options
d2o --subcommand git-log --format fish

# Preprocess only (debug option splitting)
d2o --command ls --preprocess-only

# Scan deeper for nested subcommands
d2o --command docker --depth 2 --format json
```

### Building

```bash
# Debug build
cargo build

# Release build with optimizations
cargo build --release
```

### Running with verbose output

```bash
RUST_LOG=debug ./target/release/d2o --command ls --format json
```

## Known Limitations

- Subcommand depth must be specified (default: 1 level)
- Some highly unusual help text formats may not parse perfectly
- Unicode box-drawing characters in help text are converted to ASCII

## Related Projects

- [parse-help](https://github.com/sindresorhus/parse-help)

## License

MIT - See [LICENSE](./LICENSE) file

## Contributing

Contributions welcome! Areas for improvement:

- Performance optimizations
- Additional help text format support
- More comprehensive testing
- Documentation