Metadata-Version: 2.5
Name: alku
Version: 0.5.0
Summary: Meta-framework for modern autonomous agentic development
Author-email: Ragnaruk <ima1365@me.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: click<9,>=8.1.8
Requires-Dist: markdown-it-py<5,>=3
Requires-Dist: packaging<27,>=24
Requires-Dist: pyyaml<7,>=6
Description-Content-Type: text/markdown

# Alku

Alku is a meta-framework for modern autonomous agentic development.

## Features

Alku bundles and installs several skills:
1. `alku-workflow` — main entrypoint; responsible for a complete plan-to-implementation workflow for a single feature. Automatically added to AGENTS.md.
2. `alku-auto` — autonomous long-term development; takes all planned features and sequentially launches `alku-workflow` subagents for each one.
3. `alku-brainstorm` — check current project features and create plans for future project growth; launch when you have no idea what to do with the project.
4. `alku-docs` — generate, check, and reconcile documentation with code; should be run periodically (every 3 features as a baseline) to avoid mess and drift in documentation.
5. `alku-architecture` — check high-level project structure; should be run periodically (every 3 features as a baseline) to avoid project structure from becoming a mess.

Alku takes completely ownership on the root `docs` directory and uses it for project documentation.

## Install

Until a public release exists, install Alku from a checkout:

```console
uv tool install --force .
uv tool update-shell
```

Restart the shell if `uv tool update-shell` changes `PATH`. After publication,
`uv tool install alku` will install the packaged release.

## Quick start

To add Alku to the project run `alku init`, it will:

1. Run applicable versioned migrations for an existing Alku project;
2. Create the `docs` directory;
3. Update the managed `AGENTS.md` gate and make `CLAUDE.md` import it;
4. Install bundled skills for OpenAI and Claude;
5. Install provider-native named agent profiles with role-specific effort;
6. Ask about optional integrations and external-agent handoffs when interactive;

After that, launch a new agent session and you're done.

## Documentation

- [Documentation index](docs/README.md)
- [Command reference](docs/product/api/README.md)
- [Architecture](docs/product/architecture/README.md)
- [Operations](docs/product/operations/README.md)
- [Development](docs/product/development/README.md)
- [Release readiness](docs/product/release/README.md)

Alku manages product, feature, and proposal records beneath `docs/`. The
[collection model](docs/features/structured_document_collections/README.md)
defines the record kinds, and the
[validation contract](docs/features/repository_validation/design.md) defines
their allowed structure and integrity rules.

## Development

```console
uv sync
uv run pytest
uv run ruff check .
uv run ruff format --check .
uv run ty check --extra-search-path src .
uv build
```

The test configuration requires 100% line coverage. See the
[development guide](docs/product/development/README.md) for the change workflow
and explicit large-repository regression command.
