CLI Install

The apyx binary ships in the same package as the SDK (@koed_jang/apyx-sdk). Install the package and you have the CLI.

pnpm add -g @koed_jang/apyx-sdk@prototype
apyx --version

• Three install styles
  • Project-local
  • Global
  • Without installing — pnpm dlx / npx
• Verify
• Optional: Ledger
• Requirements
• Updating

Three install styles

Project-local

Add to your project’s devDependencies and run via your package manager’s exec command. Best when the CLI is part of a workflow you share with collaborators.

pnpm add -D @koed_jang/apyx-sdk@prototype viem
pnpm exec apyx --help

Global

Install once, run anywhere. Best for daily ad-hoc use on a personal workstation.

pnpm add -g @koed_jang/apyx-sdk@prototype
apyx --help

Without installing — pnpm dlx / npx

Runs the CLI with the package fetched into a one-shot cache. Best when you want to try a specific version without committing to it.

pnpm dlx @koed_jang/apyx-sdk@prototype apyx --help
# or
npx -y @koed_jang/apyx-sdk@prototype apyx --help

Verify

$ apyx --version
0.1.0-prototype.0

A working apyx --version confirms the install + dist + binstub paths end-to-end. From there:

• Configuration — your first config file.
• REPL — the interactive shell.
• Contract Commands — the per-command index.

Optional: Ledger

Hardware-wallet support is opt-in to keep the default install lean. Install the optional native deps separately when you want it:

pnpm add @ledgerhq/hw-transport-node-hid @ledgerhq/hw-app-eth

See the Ledger Setup chapter for permissions, udev rules on Linux, and how to wire a Ledger profile into your config.

Requirements

• Node ≥ 20. The CLI is a tiny CommonJS bin that loads the SDK’s Node bundle.
• A working PATH entry for your global node_modules/.bin if you installed globally (pnpm/yarn/npm all do this automatically; if apyx isn’t found, run pnpm setup or your manager’s equivalent).

Updating

pnpm update -g @koed_jang/apyx-sdk@prototype

The prototype dist-tag always points at the latest pre-release. Pin to a specific version (e.g. @0.1.0-prototype.0) when you want reproducibility across machines.