# Documentation Reference material for ChaosCrypt. | Document | Contents | |---|---| | [API.md](API.md) | Complete Python API reference | | [CLI.md](CLI.md) | Command line reference, pipelines, troubleshooting | | [ARCHITECTURE.md](ARCHITECTURE.md) | Module map, data flow, design decisions | | [benchmark.md](benchmark.md) | Performance measurements and mode comparison | | [BUILDING.md](BUILDING.md) | Building, testing and releasing | | [../SECURITY.md](../SECURITY.md) | Design, key space, threat model, attack analysis | | [../README.md](../README.md) | Project overview and quick start | | [../CHANGELOG.md](../CHANGELOG.md) | Release history | --- ## Where to start **Evaluating whether ChaosCrypt suits your use case** Read the [Scope](../README.md#scope) section of the README, then [SECURITY.md](../SECURITY.md) for the full analysis. **Using the library in Python** [API.md](API.md) — start with the `ChaosCrypt` facade and the error table. **Using the command line** [CLI.md](CLI.md) — covers every subcommand, plus pipelines and shell aliases. **Choosing a performance mode** [benchmark.md](benchmark.md) for the numbers, [SECURITY.md §4](../SECURITY.md) for what each mode costs in cryptographic margin. **Understanding how it works** [ARCHITECTURE.md](ARCHITECTURE.md) for the code structure, and [SECURITY.md §3](../SECURITY.md) for the algorithm itself. **Contributing or building a release** [BUILDING.md](BUILDING.md).