Edit

Share via

Start-AIShell

Module:
AIShell Module

Starts an AIShell session in a split pane window of Windows Terminal and iTerm2 and connects a communication channel to the PowerShell session that started it.

Syntax

Default (Default) 

Start-AIShell
    [-Path <String>]
    [<CommonParameters>]

Description

Starts an AIShell session in a split pane window of Windows Terminal and iTerm2. The AIShell session is started in the right pane of the terminal window. The left pane is the current shell session. You must use these windows to interact with the AIShell session.

When you run this cmdlet on macOS, it checks for the presence of iTerm2. If iTerm2 is not installed, it attempts to install iTerm2 using the pip3 package manager. If iTerm2 is installed, it starts an iTerm2 session in a split pane window.

Examples

Example 1 - Start an AIShell session

Start-AIShell

Example 2 - Start an AIShell session with a specific path

Start-AIShell -PATH C:\Users\aish.exe

Parameters

-Path

By default, the cmdlet looks for the aish executable in the locations listed in the $env:PATH environment variable. Use this parameter to specify an alternate location for the aish executable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Object

Notes

PowerShell includes the following alias for this cmdlet:

  • All platforms:
    • aish