nut-shell 0.1.2

A lightweight command-line interface library for embedded systems
Documentation 
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

# DEVELOPMENT

Build workflows, testing strategies, and contribution guidelines.

## Quick Reference

```bash
# Run all CI checks locally (recommended before push)
./scripts/ci-local

# Individual checks
cargo fmt                                              # Format code
cargo clippy --all-features --all-targets -- -D warnings  # Lint
cargo test --all-features                              # Test all features
cargo check --target thumbv6m-none-eabi --release      # Verify `no_std`

# Feature testing (test graceful degradation)
cargo test --all-features
cargo test --no-default-features
cargo test --features authentication

# Embedded verification (`no_std` compliance)
cargo check --target thumbv6m-none-eabi
cargo size --target thumbv6m-none-eabi --release -- -A
```

**Available features:**
- `authentication` - User authentication with credential providers
- `completion` - Tab completion for commands and paths
- `history` - Command history with arrow key navigation
- `async` - Asynchronous command execution support

**Note:** Both the library and tests are fully `no_std` - tests use `heapless` types to maintain consistency with the library's embedded patterns.

---

## Troubleshooting

### Feature Resolution Issues

```bash
# Check which features are actually enabled
cargo tree --format "{p} {f}" | grep nut-shell

# Verify feature gates in expanded code
cargo expand --lib | grep -A 5 "cfg(feature"
```

### Binary Size Analysis

```bash
# Compare feature impact on binary size
cargo bloat --target thumbv6m-none-eabi --release --all-features
cargo bloat --target thumbv6m-none-eabi --release --no-default-features
```


---

## Contributing Checklist

Before submitting a pull request:

1. Run `./scripts/ci-local` to verify all CI checks pass
2. Test feature-gated code in both enabled/disabled states
3. Verify `no_std` compliance for core functionality
4. Check binary size impact with `cargo bloat` (if relevant)
5. Update documentation for public API changes
6. Follow existing patterns (see `docs/DESIGN.md`)

---

## Documentation

- **Quick start**: `README.md`
- **Usage examples**: `docs/EXAMPLES.md`
- **Architecture**: `docs/DESIGN.md`
- **Security**: `docs/SECURITY.md`
- **API reference**: `cargo doc --open`