# whirl

The AI chat app that sweats the details. Every top model, real memory, living documents, and your own tools.

## Start here

1. [Install and configure whirl](/docs/up-to-code-whirl/installation-guide).
2. [Run a first example](/docs/up-to-code-whirl/quick-start-guide).
3. [Use and adapt the project](/docs/up-to-code-whirl/usage-guide).

These guides use the captured README and, where available, the root package manifest. Commands copied from the source are labeled by their original task. Hosted services, credentials, and release availability must be checked in the linked repository.

## Reference and further reading

- [Quick start](/docs/up-to-code-whirl/quick-start)
- [Features](/docs/up-to-code-whirl/features)
- [Tech stack](/docs/up-to-code-whirl/tech-stack)
- [Repository layout](/docs/up-to-code-whirl/repository-layout)
- [Documentation](/docs/up-to-code-whirl/documentation)
- [Contributing](/docs/up-to-code-whirl/contributing)
- [License](/docs/up-to-code-whirl/license)

## Source and help

- [GitHub repository](https://github.com/Up-to-code/whirl)
- [Original README](https://github.com/Up-to-code/whirl/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/whirl/issues)
- [Open the project website](https://whirl.chat)

The catalog identifies the license as **MIT**. Read the repository license before redistributing source or assets.

This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.