Installation

The CoreViz CLI can be installed globally or run directly with npx. Choose the method that works best for your workflow.

Global Installation

Install the CLI globally using npm:

npm install -g @coreviz/cli

After installation, you can use the coreviz command from anywhere:

coreviz --help

Using npx (No Installation Required)

You can run the CLI directly without installing it globally:

npx @coreviz/cli [command]

This is useful for:

• One-off commands
• CI/CD pipelines
• Trying out the CLI before installing
• Avoiding global package clutter

Verify Installation

Check that the CLI is installed correctly:

coreviz --version
# or
npx @coreviz/cli --version

Requirements

• Node.js: Version 14 or higher
• npm: Version 6 or higher (comes with Node.js)

Updating

To update the CLI to the latest version:

npm install -g @coreviz/cli@latest

Troubleshooting

Command Not Found

If you get a "command not found" error after global installation:

1. Check that npm's global bin directory is in your PATH:

   npm config get prefix

2. Add it to your PATH if needed (usually ~/.npm-global/bin or /usr/local/bin)

Permission Errors

If you encounter permission errors on macOS/Linux:

sudo npm install -g @coreviz/cli

Or better yet, configure npm to use a directory you own:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
npm install -g @coreviz/cli

Next Steps

• Commands: Learn about available CLI commands
• Authentication: Set up authentication for cloud features