Skip to content

About

AXI-compliant Netlify CLI wrapper — token-efficient TOON output, structured errors, agent-first ergonomics

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

netlify-axi

An AXI-compliant wrapper around the Netlify CLI — token-efficient TOON output, structured errors, and agent-first ergonomics for AI coding agents that operate Netlify via shell.

Built on axi-sdk-js, modeled on the reference implementation gh-axi.

Status

Early scaffold (v0). Read-only commands only.

Requirements

  • Node.js >= 20
  • The Netlify CLI installed and logged in (netlify login)

Install

pnpm add -g @simkimsia/netlify-axi

Or run it without installing: npx -y @simkimsia/netlify-axi --help.

Check it: netlify-axi --version. Update later with netlify-axi update.

To work on it from a clone:

git clone https://github.com/simkimsia/netlify-axi
pnpm -C netlify-axi install
pnpm -C netlify-axi run build
pnpm add -g link:$PWD/netlify-axi   # puts `netlify-axi` on PATH

Usage

netlify-axi            # dashboard: linked site, or most recent sites
netlify-axi list       # all sites you have access to
netlify-axi status     # site linked to the current directory
netlify-axi whoami     # logged-in Netlify account
netlify-axi --help
netlify-axi --version  # fast path, never loads the command graph
netlify-axi update     # self-update (built into axi-sdk-js)

Example output (TOON):

count: 5 sites
sites[5]{name,team,url,updated}:
  my-app,Acme,https://my-app.netlify.app,3d ago
  ...
help[2]:
  Run `netlify link` in a project directory to link a site
  Run `netlify-axi status` to see the linked site

Set AXI_DEBUG=1 to print each netlify argv the axi forwards to stderr. The part after the [axi-debug] prefix can be pasted into a shell as is. stdout is unchanged.

$ AXI_DEBUG=1 netlify-axi whoami
[axi-debug] netlify api getCurrentUser

Agent skill

Install the bundled skill so your coding agent prefers netlify-axi over raw netlify, falls back to netlify when a command is not wrapped yet, and files the gap as an issue here (label agent-reported-gap):

npx skills add simkimsia/netlify-axi --skill netlify-axi -g

The skill is a discovery stub that defers to netlify-axi --help for current command guidance. Source: skills/netlify-axi/SKILL.md.

Development

pnpm install
pnpm run dev          # run from source (tsx)
pnpm test             # vitest
pnpm run build        # tsc -> dist/
pnpm run format:check

Changelog

Release notes live in CHANGELOG.md and on GitHub Releases. release-please writes both from conventional commits, so do not edit the file by hand. Breaking changes, such as a renamed error code, are listed under "⚠ BREAKING CHANGES" and bump the minor version while below 1.0.

License

MIT

About

AXI-compliant Netlify CLI wrapper — token-efficient TOON output, structured errors, agent-first ergonomics

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages