Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #46

Merged
merged 2 commits into from
Oct 31, 2023
Merged

Update README.md #46

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17a4a21
Update README.md
StevenBucher98 Oct 31, 2023
4de523e
removied old switch
StevenBucher98 Oct 31, 2023
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ShellCopilot
# Shell Copilot

This is a repository of various A.I + Shell prototypes we have created to test out experiences and
features. **ShellCopilot** is the latest and most finished prototype. It is a CLI tool that creates
features. **Shell Copilot** is the latest and most finished prototype. It is a CLI tool that creates
an interactive chat session with a registered Large Language Model. Currently we are in a **Private Preview** state and everything is subject to change.

![GIF showing demo of ShellCopilot](./docs/media/ShellCopilotDemo.gif)
![GIF showing demo of Shell Copilot](./docs/media/ShellCopilotDemo.gif)

## Installing and Using ShellCopilot
## Installing and Using Shell Copilot

Here are the steps to install and use ShellCopilot.
Here are the steps to install and use Shell Copilot.
1. Clone this repository
2. To build run `./build.ps1 -ShellCopilot` in the project's directory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This switch doesn't appear to be available in the current build.ps1. For now, you probably need to:

cd shell
dotnet publish

3. Add the `<path to project>/out/ShellCopilot.App` directory to your `$PATH` with `$env:PATH += <path to project>\out\ShellCopilot.App`
Expand Down Expand Up @@ -50,7 +50,7 @@ For the private preview we are letting users use a GPT-4 model at the
If you have separate Azure OpenAI endpoint you can use that instead of the one above. Read more at
[Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=ps).

## Using ShellCopilot
## Using Shell Copilot

To start a chat session with the LLM, simply run `aish` and it will open up a new session in your current window. You can also use `aish --use-alt-buffer` to open up a new chat session in the alternate screen buffer.

Expand Down