open-swe/apps/cli/README.md
Palash Shah 01a514b1fa
feat: add updates to cli application (#503)
* open swe cli: initial cli updates

* openswe cli: add working authentication

* open swe cli: remove unecessary console log statements

* openswe cli: typescript modifications

* openswe cli: updates to formats

* openswe cli: updates to formatting

* openswe cli: ran prettier

* openswe cli: update urls

* openswe cli: update eslint

* openswe cli: add env example

* openswe cli: add updates

* openswe cli: formatting

* openswe cli: add app installation

* openswe cli: clean up lint and formatting

* temp logs

* l

* working human feedback prompting

* stop the re-renders

* NOT WORKING -- KICKOFF PROGRAMMER

* approve programmer

* detected programmer working

* some sembleance of logging

* some changes

* working logs

* concatenated tool results

* ui improvements

* update ui

* formatting

* simple interrupt working

* working multiple sessions + padding

* working dissapearance of the approve/deny

* TEST PUSH

* cr

* generally working tool calls

* access thread ip properly

* fix naming of env example

* add readme

* formatting

* linting + formatting

* dist updates

* updates to yarn

* no tests for cli

* updates to readme

* format

* update readme

* remove auth print out

* add loading indicators

* formatting changes

* remove shared workspace

* add lock

* add dependency

* update yarn lock

* add back the installation token

* replace with variable constants

* Update apps/cli/src/auth-server.ts

Co-authored-by: Brace Sproul <braceasproul@gmail.com>

* openswe cli: updates

* openswe cli: cleanup lint

* openswe cli: update stream mode

* openswe cli: update stream mode

* openswe cli: streaming service

* openswe cli: create selector for approval

* openswe cli: remove streaming service

* openswe cli: update types to langchain

* openswe cli: update all streamModes

* openswe cli: update formatting

* openswe cli: update stream mode

* openswe cli: notify of in development

* openswe cli: change to istoolmessage

---------

Co-authored-by: bracesproul <braceasproul@gmail.com>
2025-07-29 17:37:13 -04:00

30 lines
900 B
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, repository selection, and GitHub integration directly from your terminal.
## Documentation
## Development
1. Copy the environment file: `cp .env.example .env` and fill in the required values
2. Install dependencies: `yarn install`
3. Build the CLI: `yarn build`
4. Run the CLI: `yarn cli`
## Usage
Run the CLI and follow the interactive prompts:
```bash
yarn cli
```
The CLI will guide you through:
1. GitHub authentication (if not already logged in)
2. Repository selection
3. GitHub App installation
4. Interactive chat with the Open SWE agent