Metadata-Version: 2.4
Name: tlaplus-cli
Version: 0.7.0
Summary: TLA+ tools: download TLC, compile custom modules, run model checker
Author-email: Denis Nikolskiy <codeomatics@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/nikolskiy/tlaplus-cli
Project-URL: Repository, https://github.com/nikolskiy/tlaplus-cli
Project-URL: Issues, https://github.com/nikolskiy/tlaplus-cli/issues
Project-URL: Changelog, https://github.com/nikolskiy/tlaplus-cli/blob/main/CHANGELOG.md
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer<1.0.0,>=0.22.0
Requires-Dist: requests<3.0.0,>=2.31.0
Requires-Dist: pyyaml<7.0,>=6.0
Requires-Dist: platformdirs<5.0,>=4.0
Requires-Dist: pydantic<3.0.0,>=2.12.5
Requires-Dist: truststore<1.0.0,>=0.9.0
Requires-Dist: rich<14.0.0,>=13.7.0
Dynamic: license-file

# TLA+ CLI

Command-line tool for working with TLA+ specifications and the TLC model checker.

## Project goals

1. Simplify managing TLA+ tools such as TLC, community modules, custom modules, etc.
2. Run TLA tools in a single CLI interface.
3. Manage and display the tools outputs.

## Features

* [Managing TLA+ Tools](docs/managing-tlaplus-tools/managing-tla2tools.md): Verify Java requirements, manage/pin `tla2tools.jar` versions, and handle cache settings.
* [Running TLC](docs/tlc/tlc.md): Run the TLC model checker, inspect commands, and execute model checking with custom modules.
* [Custom Java Modules](docs/java-modules-for-tlc/README.md): Compile, register, and manage custom Java operator overrides for TLC using automated CLI commands.

## Installation

For detailed installation instructions, please refer to:
* [Installation via uv tool](docs/installation/uv-tool.md)
* [Nix Flakes Installation & Development](docs/installation/nix.md)
