> ## Documentation Index
> Fetch the complete documentation index at: https://runegraft.codesft.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Runegraft

> The most customizable, beautiful, simple CLI framework.

Build CLIs the way you *wish* every CLI was built: clean command routes, strong typing, an interactive shell out of the box, and quality-of-life features that make your tool feel like a real product.

> [!TIP]
>
> Run your tool with **no args** to drop into Runegraft’s interactive shell. You still get the normal “one-shot CLI” behavior when you pass a command.

> [card] [Quickstart](https://runegraft.codesft.dev/quickstart.md)
>
> Install, create your first CLI, and ship a polished entrypoint.

> [card] [Command Routes](https://runegraft.codesft.dev/concepts/command-routes.md)
>
> Flask-like routes for CLIs: `install <url:url>`, types, and defaults.

> [card] [Interactive Shell](https://runegraft.codesft.dev/concepts/shell.md)
>
> Completion, history, aliases, `source` scripts, and more.

> [card] [Options & Flags](https://runegraft.codesft.dev/concepts/options.md)
>
> Typed options with nice help text, short/long forms, and defaults.

> [card] [Type Converters](https://runegraft.codesft.dev/concepts/types.md)
>
> Built-ins like `int`, `bool`, `url`, `json`, `uuid`, and custom converters.

> [card] [Recipes](https://runegraft.codesft.dev/recipes.md)
>
> Real-world patterns: installers, git-like subcommands, and task runners.

***

## Install in one command

```bash theme={null}
pip install runegraft
```

> [!TIP]
>
> Prefer editable installs while developing your CLI? Clone the repo and run `pip install -e .`.

## Sneak peek

```bash normal-cli theme={null}
$ runegraft install https://example.com/pkg.zip --optional-flag 3
Installing from https://example.com/pkg.zip (optional_flag=3)
```

```bash interactive-shell theme={null}
$ runegraft
runegraft> help
runegraft> install https://example.com/pkg.zip -f 3
runegraft> alias set i "install -f 3"
runegraft> i https://example.com/pkg.zip
runegraft> history show
runegraft> exit
```

## Where to start

**1. Quickstart**

Install Runegraft and ship your first command in minutes in the [Quickstart](https://runegraft.codesft.dev/quickstart.md).

**2. Command routes**

See how Flask-like routes power typed arguments in [Command Routes](https://runegraft.codesft.dev/concepts/command-routes.md).

**3. Live shell**

Explore completion, history, and scripts in [Interactive Shell](https://runegraft.codesft.dev/concepts/shell.md).

**4. Polish the UX**

Add flags, converters, and real-world patterns in [Options & Flags](https://runegraft.codesft.dev/concepts/options.md) and [Type Converters](https://runegraft.codesft.dev/concepts/types.md).

**5. Copy-paste patterns**

Grab ready-to-use snippets in [Recipes](https://runegraft.codesft.dev/recipes.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.