Docs - AiTerm

Introduction

Welcome to our comprehensive documentation. Here, you'll find a wealth of resources to help you make the most of our product. Whether you're a newcomer eager to get started or an experienced user seeking in-depth information, our documentation is your go-to source for insights, guidance, and best practices.

Installation and Update

Follow these instruction to install or update the aiterm on your computer. Currently we are maintain the packages for these operating system and linux distribution:

Linux

Ubuntu:

ARM architecture
$sudo wget https://raw.githubusercontent.com/awgst/aiterm-releases/main/aiterm_0.6.3_linux_arm64.tar.gz $sudo tar -C /usr/local/bin -xzf aiterm_0.6.3_linux_arm64.tar.gz
AMD architecture
$sudo wget https://raw.githubusercontent.com/awgst/aiterm-releases/main/aiterm_0.6.3_linux_amd64.tar.gz $sudo tar -C /usr/local/bin -xzf aiterm_0.6.3_linux_amd64.tar.gz

If you are not sure about your computer architecture you can check it by run this command:

$dpkg --print-architecture

Mac Os

Install using Homebrew:

$brew tap awgst/awgst
$brew install aiterm

Update using Homebrew:

$brew upgrade aiterm

Windows

Download installer:

If you are using powershell you can add new alias into .ps1 profile

$New-Alias -Name aiterm -value $($env:USERPROFILE)\AppData\Local\Programs\AiTerm\aiterm.exe

then run this command for apply new aliases:

$Set-ExecutionPolicy RemoteSigned
$. $PROFILE

If you have no idea about .ps1 profile just run as administrator your powershell then run these following commands:

$New-Item -path $PROFILE -type "file" -value "New-Alias -Name aiterm -value $($env:USERPROFILE)\AppData\Local\Programs\AiTerm\aiterm.exe" -Force; Set-ExecutionPolicy RemoteSigned; . $PROFILE

If you are using gitbash you can add path into gitbash using following commands:

$echo "export PATH=$PATH:/c/Users/$USERNAME/AppData/Local/Programs/AiTerm" >> .bashrc
$source ~/.bashrc

Currently you need to use winpty to make aiterm work properly on git bash, so you can add an alias by run these commands:

$echo 'alias aiterm="winpty aiterm"' >> .bashrc
$source ~/.bashrc

Release Notes

You can find out more about our releases notes by follow this link

API Token

To use AiTerm you will need to create an API token. On the first time you run aiterm on your terminal it will ask you to input an API Token. You can create API token from the API Token page.

Usage

For more detail information about the commands you can use aiterm -h or aiterm --help.

Force

If you set -f or --force flags on your command it will not asking you about the confirmation for running the commands list are needed to run.

Interactive Mode

If you enter the interactive mode, you can do commands or ask question without need to write 'aiterm` on you commands.

Explain

If you are need description or explanation about the generated commands you can set -e flags

New Session

Create new discussion session for getting better answer or commands.

Preferences

Edit your AiTerm usage preferences here are list of valid preference variable that can be used

Key	Description
ask_cmd_execution	Any command execution from aiterm's generated will ask you about confirmation prompt, if you prefer to run all the generated commands without any ask of confirmation you can set this preference with value false. Default value is true
editor	Set preferenced text editor for aiterm's action that required text editor. By default the value is nano, unfortunately on windows only support notepad for now.
terminal	Set terminal name like iTerm, powershell etc., to get a better generated command. This preference key is not mandatory you can leave it to blank if you don't want to tell us what terminal that you used for aiterm.
token	Your API token will be saved in here

Quiet

Will not outputing the commands running result.

Set Token

If you want to change the API token that you have generated new from the API Token page.

Version

Showing the version that you used.

Help

We are here to help you.

Contact Us

We will be very happy to receive messages from you, whether it is related to feedback, bugs, errors or just to say hello to us. Please send a message to info@aiterm.net to reach us.

FAQ

Please visit the FAQ page.

Privacy Policy

Please visit the Privacy Policy page.