# Optique

> Type-safe combinatorial CLI parser for TypeScript

Express CLI constraints in code structure,<br>not validation logic

## Table of Contents




### Concepts

- [Primitive parsers](/concepts/primitives.md): Primitive parsers are the foundational building blocks that handle basic CLI elements like options, arguments, commands, and constants with full type safety and clear error messages.
- [Value parsers](/concepts/valueparsers.md): Value parsers convert string arguments into strongly-typed values with validation, supporting built-in types like integers, URLs, and UUIDs, plus custom parser creation.
- [Modifying combinators](/concepts/modifiers.md): Modifying combinators enhance existing parsers by making them optional, providing defaults, transforming results, or allowing multiple occurrences while preserving type safety.
- [Construct combinators](/concepts/constructs.md): Construct combinators compose multiple parsers into complex structures using object(), tuple(), or(), and merge() to build sophisticated CLI interfaces with full type inference.
- [Inter-option dependencies](/concepts/dependencies.md): Inter-option dependencies allow one option's valid values to depend on another option's value, enabling dynamic validation and context-aware shell completion.
- [Shell completion](/concepts/completion.md): Learn how to add shell completion support to your CLI applications using Optique's built-in completion system. Covers Bash and zsh integration, custom suggestions, and native file completion.
- [Man pages](/concepts/man.md): Learn how to generate Unix man pages from your CLI application using Optique's man page generator. Covers man page format, customization options, and integration patterns.
- [Structured messages](/concepts/messages.md): Structured messages provide a type-safe way to create rich error messages and help text using template literals with semantic components for options, values, and metavariables.
- [Runners and execution](/concepts/runners.md): Learn about the different ways to execute parsers in Optique: from low-level parsing to high-level process integration with automatic error handling and help text generation.
- [Extending Optique with runtime context](/concepts/extend.md)

### Integrations

- [Config file support](/integrations/config.md): Load configuration files with type-safe validation using Standard Schema compatible libraries like Zod, Valibot, and ArkType.
- [Git integration](/integrations/git.md): Git value parsers for validating branches, tags, commits, and remotes using isomorphic-git.
- [LogTape integration](/integrations/logtape.md): Integrate LogTape logging with Optique CLI applications using various parsing strategies for log levels, verbosity flags, and output destinations.
- [Temporal integration](/integrations/temporal.md): Parse ISO 8601 dates, times, durations, and time zones into Temporal API objects with full type safety and validation.
- [Valibot integration](/integrations/valibot.md): Use Valibot schemas for validating command-line arguments with a lightweight, modular validation library offering minimal bundle size.
- [Zod integration](/integrations/zod.md): Use Zod schemas for validating command-line arguments with seamless integration, type inference, and transformation support.



### Other

- [Installation](/install.md): Instructions for installing Optique.