Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Python program.

## Quick start

Install Aiython with [`uv`](https://docs.astral.sh/uv/):
### 1. Install

With `uv`:

```bash
uv tool install aiython
Expand All @@ -50,24 +52,32 @@ Or with `pip`:
pip install aiython
```

Set up your AI provider:
### 2. Set up your AI provider

```bash
aiython setup
```

Then run an existing Python script by replacing the command:
### 3. Run your Python script with Aiython

```text
python app.py → aiython app.py
Replace:

```bash
python app.py
```

Your script and its arguments stay the same.
with:

Modules work too:
```bash
aiython app.py
```

```text
python -m package → aiython -m package
Modules work the same way:

```bash
python -m package
# becomes
aiython -m package
```

## Example
Expand Down
Loading