Agent-ergonomic AXI wrapper around mesheryctl. Prefer this over raw mesheryctl for agent workflows: token-efficient TOON list/view reporting, definitive empty states, structured errors, help[] next-step suggestions, and always-non-interactive execution.
It follows the gh-axi pattern: it wraps the human CLI instead of changing it. Design and scope: meshery/meshery#20979.
npx -y mesheryctl-axiPre-release (v0.x). The package structure, error contract, TOON rendering, and release pipeline are in place. Some v1 commands still depend on mesheryctl output that does not exist yet (for example, JSON output from mesheryctl <resource> list). #12 tracks everything left before the first npm release. Issues labelled good first issue are a good place to start.
- Node.js >= 22
mesheryctlinstalled and authenticated. This package spawnsmesheryctl; it does not embed Meshery.- Install: https://docs.meshery.io/installation
- Override the binary:
MESHERYCTL_BIN=/path/to/mesheryctl
# Content-first home: description, bin path, best-effort system status/context
npx -y mesheryctl-axi
# TOON list/view reporting
npx -y mesheryctl-axi connection list
npx -y mesheryctl-axi system status
npx -y mesheryctl-axi system context
npx -y mesheryctl-axi design list
npx -y mesheryctl-axi model list
npx -y mesheryctl-axi component list
# Schema-faithful content retrieve (YAML/JSON - never TOON-as-content)
npx -y mesheryctl-axi design content <name> --format yaml
npx -y mesheryctl-axi model content <name> --format json| Concern | Behavior |
|---|---|
| List / view metadata | TOON |
| Design / model content | Raw YAML or JSON only |
| Unknown flags | Non-zero exit + structured TOON error |
| Empty results | Definitive empty states (e.g. connections: 0) |
| Success | Includes help[] suggestions |
| Interactivity | Always non-interactive (no TTY prompts) |
mesheryctl-axi # home
mesheryctl-axi connection list|view
mesheryctl-axi system status|context
mesheryctl-axi design list|view|content
mesheryctl-axi model list|view|content
mesheryctl-axi component list|view
make setup # npm ci
make build # tsc -> dist/
make tests # vitest
make dev ARGS="connection list" # run from sourceCI (node-checks.yml) builds, tests, smoke-runs the built bin, and dry-runs npm pack on Node.js 22 and 24.
Releases are automation-driven: merged PRs update a Release Drafter draft, and publishing that draft publishes mesheryctl-axi to npm. Never npm publish by hand. See docs/release-procedure.md; agents use the mesheryctl-axi-release skill.
Contributions are welcome. Please read CONTRIBUTING.md and the Code of Conduct, and sign off your commits (DCO). New to Meshery? Start with the Newcomers' Guide and say hello in the community Slack.
Security issues: see SECURITY.md.