Skip to main content

CLI versions and upgrades

This page explains how to check the installed ikw version, compare it with published releases, and upgrade the CLI without breaking a workstation.

Check the installed version​

ikw --version

To confirm which binary your shell is running:

which ikw

On Windows PowerShell:

Get-Command ikw

Check the latest available release​

CLI npm releases are published as the @ikawaari/ikw package.

The CLI also exposes built-in release commands:

ikw release latest
ikw release dist-tags
ikw release check
npm view @ikawaari/ikw version

To inspect published channels:

npm view @ikawaari/ikw dist-tags

Interpret tags as follows:

TagUsage
latestRecommended stable version.
nextPre-release or validation candidate. Use only to test the next version.
beta / rcTemporary channel when the team prepares a major version or surface change.

Compare local, npm, and one-off execution​

Use this block for a quick workstation check:

ikw --version
ikw release check
npm view @ikawaari/ikw version
npm view @ikawaari/ikw dist-tags
npx @ikawaari/ikw@latest --version

If ikw --version and npx @ikawaari/ikw@latest --version print different versions, the globally installed binary is stale or your PATH points to an older installation.

Inspect a release before upgrading​

ikw release inspect latest
npm view @ikawaari/ikw@latest name version dist.tarball dist.integrity engines dependencies

For a specific version:

ikw release inspect 0.7.0
npm view @ikawaari/ikw@0.7.0 name version dist.tarball dist.integrity engines dependencies

Check at minimum:

  • the published version;
  • the selected tag (latest, next, beta, rc);
  • the required Node version in engines;
  • the @ikawaari/cli-sdk and @ikawaari/sdk dependencies;
  • the npm integrity field (dist.integrity).

GitHub release notes follow the ikw/vX.Y.Z tag when the version is published from the CLI repository.

Upgrade the CLI​

Global npm installation​

npm install -g @ikawaari/ikw@latest
ikw --version

To test a version without keeping it:

npx @ikawaari/ikw@latest --version
npx @ikawaari/ikw@latest --help

Run without a global installation​

npx @ikawaari/ikw@latest --help

Downloaded binary​

If you use a downloaded binary, replace the old binary with the latest version available for your platform, then verify:

ikw --version
ikw --help

Verify a pre-release​

Do not install a pre-release globally unless you are explicitly testing that channel.

ikw release check-prerelease --tag next
npm view @ikawaari/ikw dist-tags
npx @ikawaari/ikw@next --version
npx @ikawaari/ikw@next --help

If the test is successful and the team asks you to use this channel:

npm install -g @ikawaari/ikw@next
ikw --version

Verify the upgrade​

After upgrading:

ikw --help
ikw login --help
ikw config --help
ikw payments --help

The upgrade is correct when:

  • ikw --version prints the expected version;
  • ikw --help prints the command list;
  • the main help commands run without errors;
  • npx @ikawaari/ikw@latest --help works if you use npm.

Troubleshooting​

SymptomRecommended action
ikw is not foundCheck that the global npm directory is in your PATH.
Old version after upgradeClose and reopen the terminal, then run ikw --version again.
npm permission errorReinstall using a global npm directory writable by your user.
npx runs an old versionUse npx @ikawaari/ikw@latest --help.
latest is not the expected versionCheck npm view @ikawaari/ikw dist-tags; the release may be published under next before promotion.
The command works with npx but not globallyCheck which ikw or Get-Command ikw, then fix PATH.