Installation

Avis is a machine-level developer CLI. Install it once on your computer, then run avis from inside any supported project.

During alpha, npm is the first distribution channel:

npm install -g avis-dev@alpha

The installed command is avis:

avis --help

Verify the command is available:

avis list
avis --version

Update Avis

During alpha, update an existing global install by reinstalling the alpha tag:

npm install -g avis-dev@alpha

Avis can print the update instructions locally:

avis upgrade

To see which package version is currently installed:

avis --version

To inspect npm’s current package tags:

npm dist-tag ls avis-dev

Important Distinction

There are two separate package-management concerns:

How you install the Avis CLI on your machine.
How Avis installs dependencies into your target project.

Avis may be installed through npm because the CLI is currently built with TypeScript and Node.js. That does not make Avis a Node dependency of your Django, Flutter, Laravel, Rust, Go, or other target project.

Do not add Avis to:

requirements.txt
pyproject.toml
composer.json
pubspec.yaml
Cargo.toml
application package manifests for target projects

Use Avis Inside a Project

After installation, enter an existing project:

cd my-next-app
avis doctor
avis add state-management

Or:

cd my-django-project
avis doctor
avis add django-rest-framework

When Avis adds an integration, it uses the target project’s native package manager. For example, Next.js uses npm, pnpm, yarn, or bun. Django uses pip, uv, or Poetry.

Alpha Publishing Standard

The npm alpha package should contain the compiled CLI bundle, package metadata, README, license, and notice files. Before publishing a new alpha, run:

pnpm release:check

If local npm cache permissions block the pack step, rerun the pack check with a writable cache:

npm_config_cache=/private/tmp/avis-npm-cache npm pack --dry-run

Local Development Install

If you are working from source instead of the npm alpha package, clone the repository and build locally:

Clone the repository and install dependencies:

git clone https://github.com/njokuchidinma/avis-dev.git
cd avis-dev
pnpm install
pnpm build

Run the CLI through the root script:

pnpm avis

Or run the built CLI directly:

node packages/cli/dist/index.js

Try Avis Inside Another Project

Build Avis first, then run the built CLI from the project you want to inspect:

cd path/to/my-next-app
node path/to/avis-dev/packages/cli/dist/index.js