mirror of
https://github.com/Sea-Haven-Industries/open-swe.git
synced 2026-09-30 22:03:14 +00:00
0591a907c7
* openswe cli: add planner and manager changes * openswe cli: fix programmer config * openswe cli: formatting * openswe cli: add config to reviewer * Potential fix for code scanning alert no. 17: Incomplete string escaping or encoding Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * openswe cli: update code security * openswe cli: add programmer to local modification set * openswe cli: fix config injection * openswe cli: add config to take action * openswe cli: update nodes * openswe cli: fix edit and view tools * openswe cli: add safety guardrails * openswe cli: local mode * openswe cli: openswe import * bug: fixing error about root dir is ambiguous * bug: remove index * bug: fix lint * feat: update logging * fix: update tool name * fix: update the formatting of approve/deny * style: update formatting * fix: update the streaming phase to streaming * style: update formatting * fix: update env example * fix: fix openPR local mode * fix: remove interrupt messages * style: formatting changes * fix: remove web mode * fix: update formatting * nit: update the readme * fix: update lock file * fix: update lint * style: eslint * fix: update functions * fix: update imports for lint * fix: remove merge conflicts * fix: formatting * fix: remove unneeded files * fix: adjust type errors * fix: modify changes based on previous mods * fix: formatting * fix: review changes * fix: update conclusion * fix: update types * fix: local mode take review * fix: never used import * fix: remove throe * fix: update formatting * fix: remove uneeded env example * fix: random formatting * fix: unused imports * fix: formatting changes * fix: formatting * fix: small nits * format: updates to tools * fix: update spelling of underscore * omit changes in open pr node * get abs path not local path * dont commit in local mode * cr * dont commit in local mode * cr * cr --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: bracesproul <braceasproul@gmail.com>
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
# Open SWE CLI
|
|
|
|
> **⚠️ Under Development**
|
|
> This CLI is currently under active development and may contain bugs or incomplete features.
|
|
|
|
A command-line interface for Open SWE that provides a terminal-based chat experience to interact with the autonomous coding agent. Built with React and Ink, it offers real-time streaming of agent logs and works directly on your local codebase without requiring GitHub authentication.
|
|
|
|
## Documentation
|
|
|
|
## Development
|
|
|
|
1. Install dependencies: `yarn install`
|
|
2. Create a `.env` file and set `OPEN_SWE_LOCAL_PROJECT_PATH` to point to an existing git repository:
|
|
```bash
|
|
echo "OPEN_SWE_LOCAL_PROJECT_PATH=/path/to/your/git/repository" > .env
|
|
```
|
|
3. Build the CLI: `yarn build`
|
|
4. Run the CLI: `yarn cli`
|
|
|
|
## Usage
|
|
|
|
Run the CLI and start chatting with the agent about your local codebase:
|
|
|
|
```bash
|
|
yarn cli
|
|
```
|
|
|
|
The CLI will:
|
|
|
|
1. Start in local mode (no authentication required)
|
|
2. Work directly on files in your current directory
|
|
3. Provide interactive chat with the Open SWE agent
|
|
4. Stream real-time logs and responses
|
|
|
|
## Prerequisites
|
|
|
|
- An existing git repository that you want to work on
|
|
- The repository must be initialized with git and have at least one commit
|
|
|
|
## Features
|
|
|
|
- **Local Mode Only**: Works directly on your local codebase without GitHub integration
|
|
- **Real-time Streaming**: See agent logs and responses as they happen
|
|
- **Interactive Chat**: Type your requests and get immediate feedback
|
|
- **Plan Approval**: Review and approve/deny proposed plans before execution
|