@@ -16,8 +16,6 @@ This project is currently in a very early **public preview** state. Expect many
1616to the code as we experiment and refine the user experiences of this tool. We appreciate your
1717feedback and patience as we continue our development.
1818
19- ![ GIF showing demo of the AI Shell] [ 04 ]
20-
2119## New to AI Shell?
2220
2321To learn more about AI Shell, we recommend you check out the [ overview] [ 19 ] page of the AI Shell
@@ -28,6 +26,14 @@ PowerShell 7. For more information see,
2826- [ Get Started with AI Shell in PowerShell] [ 15 ]
2927- [ Get Started with AI Shell (standalone)] [ 16 ]
3028
29+ ### AI Shell in PowerShell
30+
31+ ![ GIF showing demo of the AI Shell in PowerShell] [ 21 ]
32+
33+ ### Standalone experience
34+
35+ ![ GIF showing demo of the AI Shell standalone] [ 20 ]
36+
3137## Getting AI Shell
3238
3339AI Shell is supported on Windows, MacOS and Linux, however the best experience you can have is with
@@ -70,34 +76,6 @@ README in the each agent folder.
7076
7177To learn more about how to create an agent for yourself please see, [ Creating an Agent] [ 03 ] .
7278
73- ## Usage
74-
75- To start a chat session with the LLM, run ` aish ` , which starts a new session in your current window.
76- Choose the agent you would like to use. Once you select an agent you can begin your conversation.
77-
78- We suggest using a split pane approach with the terminal of choice. In Windows Terminal, use the
79- following command to start ` aish ` in a new split pane:
80-
81- ``` shell
82- wt -w 0 sp aish
83- ```
84-
85- You can bind this command to a key like ` F3 ` in your PowerShell session. Add the following code to
86- your ` $PROFILE ` script:
87-
88- ``` powershell
89- $PSReadLineSplat = @{
90- Chord = 'F3'
91- ScriptBlock = {
92- wt -w 0 sp --tabColor '#345beb'--size 0.4 -p $env:WT_PROFILE_ID --title 'AIShell' <full-path-to-aish.exe>
93- }
94- }
95- Set-PSReadLineKeyHandler @PSReadLineSplat
96- ```
97-
98- Similarly, you can use iTerm2 to get a similiar split pane experience on MacOS. You can split the
99- pane vertically by pressing ` Cmd + D ` and then run ` aish ` in one of the panes.
100-
10179### Chat commands
10280
10381By default, ` aish ` provides a base set of chat ` / ` commands used to interact with the responses from
@@ -139,7 +117,7 @@ key bindings will be supported in future releases.
139117
140118Currently, AI Shell supports very basic configuration. One can creates a file named ` config.json `
141119under ` ~/.aish ` to configure AI Shell, but it only supports declaring the default agent to use at
142- startup. This way you do not need to select agents everytime you run ` aish.exe `
120+ startup. This way you do not need to select agents every time you run ` aish.exe `
143121
144122Configuration of AI Shell will be improved in future releases to support custom key bindings, color
145123themes and more.
@@ -205,4 +183,6 @@ bugs, suggestions, or feedback.
205183[ 17 ] : https://learn.microsoft.com/powershell/utility-modules/aishell/how-to/agent-azure
206184[ 18 ] : https://github.com/PowerShell/PowerShell/releases/tag/v7.4.6
207185[ 19 ] : https://learn.microsoft.com/powershell/utility-modules/aishell/overview
186+ [ 20 ] : ./docs/media/standalone-startup.gif
187+ [ 21 ] : ./docs/media/aishellwithPowerShell.gif
208188[ logo ] : ./docs/media/AIShellIconSVG.svg
0 commit comments