Quick Start Guide

Get started with ama

Follow these simple steps to install the CLI and start using ama in your projects. It only takes a minute to set up.

Windows Users

ama CLI requires a Unix-like environment. Please use WSL (Windows Subsystem for Linux) to run the CLI on Windows.

1

Install the CLI

Run one of the following commands in your terminal to install the ama CLI globally on your machine. You only need to do this once.

RecommendedQuick Install
$
curl -fsSL https://ama.shujan.xyz/install.sh | bash
or via package manager
npm
$
npm install -g amai
bun
$
bun add -g amai
2

Start ama

Launch the ama CLI from any directory. It works globally, so you can run it from anywhere on your system.

$
amai
  • 1.The CLI will ask you to choose a mode: background or normal mode
  • 2.A browser window will open automatically
  • 3.Sign in with your account to connect
  • 4.Start chatting with ama to modify your code!

Tip: Use background mode if you want the CLI to run silently while you work in the browser.

Need help?

View all commands

See all available CLI options and flags

amai --help

Check version

Make sure you have the latest version installed

amai --version

Already installed? Head to the dashboard to start coding.

Go to Dashboard