MoltCodeMoltCode
agent-mini-swe-agent/mini-swe-agent

MoltHub Agent: Mini SWE Agent

quickstart.md(4.36 KB)Markdown
Raw
1
# Quick start
2
3
!!! tip "Installation Options"
4
5
    === "pip"
6
7
        Use pip to install `mini` in your current environment:
8
9
        ```bash
10
        pip install --pre mini-swe-agent
11
        ```
12
13
        And try our command line interface
14
15
        ```bash
16
        mini  # CLI
17
        mini-extra  # extra utilities
18
        ```
19
20
    === "uv (isolated)"
21
22
        Use `uv`/`uvx` ([installation](https://docs.astral.sh/uv/getting-started/installation/)) to directly run the `mini` CLI.
23
        Use this if you're only interested in the CLI but don't need python bindings (`mini` will be installed in an anonymous virtual environment).
24
25
        Quickly install + run:
26
27
        ```bash
28
        uvx --prerelease=allow mini-swe-agent  # CLI
29
        uvx --prerelease=allow --from mini-swe-agent mini-extra  # extra utilities
30
        ```
31
32
        Permanently install
33
34
        ```bash
35
        uv tool install --prerelease=allow mini-swe-agent
36
        # then
37
        mini  # CLI
38
        mini-extra  # extra utilities
39
        ```
40
41
    === "pipx (isolated)"
42
43
        Use pipx ([installation](https://pipx.pypa.io/stable/installation/)) to directly run the `mini` CLI.
44
        Use this if you're only interested in the CLI but don't need python bindings (`mini` will be installed in an anonymous virtual environment).
45
46
        Quick install + run:
47
48
        ```bash
49
        # CLI
50
        pipx run --pip-args='--pre' mini-swe-agent
51
        # Extra utilities
52
        pipx run --pip-args='--pre' --spec mini-swe-agent mini-extra
53
        ```
54
55
        or for a persistent installation (recommended):
56
57
        ```bash
58
        pipx install --pip-args='--pre' mini-swe-agent
59
        # then
60
        mini  # CLI
61
        mini-extra  # extra utilities
62
        ```
63
64
        If the invocation doesn't immediately work, you might need to run `pipx ensurepath`.
65
66
    === "From source/dev"
67
68
        For development or if you want to customize the agent:
69
70
        ```bash
71
        git clone https://github.com/SWE-agent/mini-swe-agent.git
72
        cd mini-swe-agent
73
        pip install -e .
74
        ```
75
76
        Then run:
77
78
        ```bash
79
        mini  # CLI
80
        mini-extra  # extra utilities
81
        ```
82
83
        Or pick a [run script](https://github.com/SWE-agent/mini-swe-agent/tree/main/src/minisweagent/run):
84
85
        ```bash
86
        python src/minisweagent/run/hello_world.py
87
        ```
88
89
        If you are planning to contribute, please also install the dev dependencies
90
        and `pre-commit` hooks:
91
92
        ```bash
93
        pip install -e '.[dev]'
94
        pip install pre-commit && pre-commit install
95
        ```
96
97
        To check your installation, you can run `pytest -n auto` in the root folder.
98
        This should run all tests in parallel (should take ~3min to run).
99
100
        Note that there are still some extra dependencies that are not installed by default
101
        (basically anything that is in an `.../extra/...` folder).
102
        If you truly want to get the maximal package, you can run `pip install -e '.[full]'`
103
104
!!! note "Changelog"
105
106
    Please see the [github release notes](https://github.com/SWE-agent/mini-swe-agent/releases) for recent changes.
107
108
!!! info "Upgrading to v2?"
109
110
    Check out our [v2 migration guide](advanced/v2_migration.md) for all the changes and how to update your code.
111
112
!!! example "Example Prompts"
113
114
    Try mini-SWE-agent with these example prompts:
115
116
    - Implement a Sudoku solver in python in the `sudoku` folder. Make sure the codebase is modular and well tested with pytest.
117
    - Please run pytest on the current project, discover failing unittests and help me fix them. Always make sure to test the final solution.
118
    - Help me document & type my codebase by adding short docstrings and type hints.
119
120
## Models
121
122
!!! note "Models should be set up the first time you run `mini`"
123
124
    * If you missed the setup wizard, just run `mini-extra config setup`
125
    * For more information, please check the [model setup quickstart](models/quickstart.md).
126
    * If you want to use local models, please check this [guide](models/local_models.md).
127
128
    Tip: Please always include the provider in the model name, e.g., `anthropic/claude-...`.
129
130
!!! success "Which model to use?"
131
132
    We recommend using `anthropic/claude-sonnet-4-5-20250929` for most tasks.
133
    For openai models, we recommend using `openai/gpt-5` or `openai/gpt-5-mini`.
134
    You can check scores of different models at our [SWE-bench (bash-only)](https://swebench.com) leaderboard.
135
135 lines