Skip to content

Commit

Permalink
Add the installation script to facilitate the AIShell installation an…
Browse files Browse the repository at this point in the history 
…d uninstallation (#285)
  • Loading branch information
@calvinhzy
calvinhzy authored Nov 18, 2024
1 parent 79f2c77 commit 36563c0
Showing 1 changed file with 207 additions and 0 deletions.
207 changes: 207 additions & 0 deletions tools/scripts/install-aishell.ps1
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

param(
[Parameter(HelpMessage = "Specify this parameter to uninstall AI Shell")]
[switch] $Uninstall
)

$Script:MacSymbolicLink = '/usr/local/bin/aish'
$Script:MacInstallationLocation = "/usr/local/AIShell"
$Script:WinInstallationLocation = "$env:LOCALAPPDATA\Programs\AIShell"
$Script:InstallLocation = $null
$Script:PackageURL = $null

function Resolve-Environment {
if ($PSVersionTable.PSVersion -lt [version]"7.4.6") {
throw "PowerShell v7.4.6 or higher is required for using the AIShell module. You can download it at https://github.com/PowerShell/PowerShell/releases/tag/v7.4.6 "
}
if ($IsLinux) {
throw "Sorry, this install script is only compatible with Windows and macOS. If you want to install on Linux, please download the package directly from the GitHub repo at aka.ms/AIShell-Repo."
}

($platShortName, $platFullName, $pkgExt, $location) = if ($IsWindows) {
'win', 'Windows', 'zip', $Script:WinInstallationLocation
} else {
'osx', 'macOS', 'tar.gz', $Script:MacInstallationLocation
}

$architecture = [System.Runtime.InteropServices.RuntimeInformation]::OSArchitecture.ToString()
if ($architecture -notin @('X86', 'X64', 'Arm64')) {
throw "AI Shell doesn't support the $architecture architecture on $platFullName."
}

$Script:InstallLocation = $location
$Script:PackageURL = "https://github.com/PowerShell/AIShell/releases/download/v1.0.0-preview.1/AIShell-1.0.0-preview.1-${platShortName}-$($architecture.ToLower()).${pkgExt}"
}

function Install-AIShellApp {
[CmdletBinding()]
param()

$destination = $Script:InstallLocation
$packageUrl = $Script:PackageURL

$destinationExists = Test-Path -Path $destination
if ($destinationExists) {
$anyFile = Get-ChildItem -Path $destination | Select-Object -First 1
if ($anyFile) {
$remove = $PSCmdlet.ShouldContinue("Do you want to remove it for a new installation?", "AI Shell was already installed (or partially installed) at '$destination'.")
if ($remove) {
$destinationExists = $false
if ($IsWindows) {
Remove-Item -Path $destination -Recurse -Force -ErrorAction Stop
} else {
sudo rm -rf $destination
if ($LASTEXITCODE -ne 0) {
throw "Failed to remove '$destination'."
}
}
} else {
throw "Operation cancelled. You can remove the current installation by './install-aishell.ps1 -Uninstall' and try again."
}
}
}

if (-not $destinationExists) {
# Create the directory if not existing.
if ($IsWindows) {
$null = New-Item -Path $destination -ItemType Directory -Force
} else {
# '/usr/local' requires sudo.
sudo mkdir $destination
if ($LASTEXITCODE -ne 0) {
throw "Failed to create the installation folder '$destination'."
}
}
}

$fileName = [System.IO.Path]::GetFileName($packageUrl)
$tempPath = Join-Path ([System.IO.Path]::GetTempPath()) $fileName
if (Test-Path $tempPath) {
Remove-Item $tempPath -Force -ErrorAction Stop
}

# Download AIShell package.
Write-Host "Downloading AI Shell package '$fileName' ..."
Invoke-WebRequest -Uri $packageUrl -OutFile $tempPath -ErrorAction Stop

try {
# Extract AIShell package.
Write-Host "Extracting AI Shell to '$destination' ..."
Unblock-File -Path $tempPath
if ($IsWindows) {
Expand-Archive -Path $tempPath -DestinationPath $destination -Force -ErrorAction Stop

# Set the process-scope and user-scope Path env variables to include AIShell.
$envPath = $env:Path
if (-not $envPath.Contains($destination)) {
Write-Host "Adding AI Shell app to the Path environment variable ..."
$env:Path = "${destination};${envPath}"
$userPath = [Environment]::GetEnvironmentVariable('Path', [EnvironmentVariableTarget]::User)
$newUserPath = $userPath.EndsWith(';') ? "${userPath}${destination}" : "${userPath};${destination}"
[Environment]::SetEnvironmentVariable('Path', $newUserPath, [EnvironmentVariableTarget]::User)
}
} else {
sudo tar -xzf $tempPath -C $destination
if ($LASTEXITCODE -ne 0) {
throw "Failed to extract '$tempPath' to the folder '$destination'."
}

$aishPath = Join-Path $destination 'aish'
sudo chmod +x $aishPath
if ($LASTEXITCODE -ne 0) {
throw "Failed to set the execution permission to the executable '$aishPath'."
}

# No need to setup the Path env variable as the symbolic link is already within Path.
$symlink = $Script:MacSymbolicLink
if (-not (Test-Path -Path $symlink)) {
sudo ln -s $aishPath $symlink
if ($LASTEXITCODE -ne 0) {
throw "Failed to create the symbolic link '$symlink' to '$aishPath'."
}
}
}
} finally {
if (Test-Path -Path $tempPath) {
Remove-Item -Path $tempPath -Force -ErrorAction SilentlyContinue
}
}
}

function Uninstall-AIShellApp {
$destination = $Script:InstallLocation
if (Test-Path $destination) {
Write-Host "Removing AI Shell app from '$destination' ..."
if ($IsWindows) {
Remove-Item -Path $destination -Recurse -Force -ErrorAction Stop

# Update the user-scope Path env variables to remove AIShell.
$userPath = [Environment]::GetEnvironmentVariable('Path', [EnvironmentVariableTarget]::User)
if ($userPath.Contains($destination)) {
Write-Host "Removing AI Shell app from the user-scope Path environment variable ..."
$newUserPath = $userPath.Split(';', [StringSplitOptions]::RemoveEmptyEntries -bor [StringSplitOptions]::TrimEntries) |
Where-Object { $_ -ne $destination } |
Join-String -Separator ';'
[Environment]::SetEnvironmentVariable("Path", $newUserPath, [EnvironmentVariableTarget]::User)
}
} else {
sudo rm -rf $destination
if ($LASTEXITCODE -ne 0) {
throw "Failed to remove the AIShell app from '$destination'."
}

$symlink = $Script:MacSymbolicLink
sudo rm $symlink
if ($LASTEXITCODE -ne 0) {
throw "Failed to remove the symbolic link '$symlink'."
}
}
} else {
Write-Host "AI Shell app was not found at '$destination'. Skip removing it."
}
}

function Install-AIShellModule {
if ($IsWindows) {
Write-Host "Installing the PowerShell module 'AIShell' ..."
Install-PSResource -Name AIShell -Repository PSGallery -Prerelease -TrustRepository -ErrorAction Stop -WarningAction SilentlyContinue
} else {
Write-Host -ForegroundColor Yellow "Currently the AIShell PowerShell module will only work in iTerm2 terminal and still has limited support but if you would like to test it, you can install it with 'Install-PSResource -Name AIShell -Repository PSGallery -Prerelease'."
Write-Host -ForegroundColor Yellow "The AI Shell app has been added to your path, please run 'aish' to use the standalone experience."
}
}

function Uninstall-AIShellModule {
if (Get-InstalledPSResource -Name "AIShell" -ErrorAction SilentlyContinue) {
try {
Write-Host "Uninstalling AIShell Module ..."
Uninstall-PSResource -Name AIShell -ErrorAction Stop
} catch {
throw "Failed to uninstall the 'AIShell' module. Please check if the module got imported in any active PowerShell session. If so, please exit the session and try this script again."
}
}
}

<###################################
#
# Setup/Execute
#
###################################>

Resolve-Environment

if ($Uninstall) {
Uninstall-AIShellApp
Uninstall-AIShellModule

$message = $IsWindows ? "AI Shell App and PowerShell module have" : "AI Shell App has"
Write-Host "`n$message been successfully uninstalled." -ForegroundColor Green
} else {
Install-AIShellApp
Install-AIShellModule

$message = $IsWindows ? "'Start-AIShell'" : "'aish'"
Write-Host "`nInstallation succeeded. To learn more about AI Shell please visit https://aka.ms/AIShell-Docs. To get started please run $message to start AI Shell." -ForegroundColor Green
}

0 comments on commit 36563c0

Please sign in to comment.