Installation

Installation

This page provides detailed installation instructions for Zcrafter across different platforms.

System Requirements

Before installing Zcrafter, ensure your system meets these requirements:

  • Node.js: Version 16.0.0 or higher
    • Recommended: Node.js 18 LTS or Node.js 20 LTS
    • Minimum: Node.js 16.x
  • npm: Version 7.0.0 or higher (comes with Node.js)
  • Operating System:
    • macOS 10.15 or later
    • Windows 10 or later
    • Linux (most modern distributions)
  • Internet Connection: Required for AI features
  • Disk Space: At least 100 MB free space

Checking Node.js Version

Before installing, verify your Node.js version by opening your terminal and typing:

node --version

Expected output should be v16.0.0 or higher.

If you need to install or upgrade Node.js, visit nodejs.org and download the LTS (Long Term Support) version for your operating system.

Installing Zcrafter

Standard Installation

Install Zcrafter globally using npm. Open your terminal and type:

npm install -g zcrafter

This installs Zcrafter globally on your system, making the zcrafter command available from any directory.

Installation with Sudo (macOS/Linux)

If you encounter permission errors, use sudo:

sudo npm install -g zcrafter

Windows Installation

On Windows, open Command Prompt or PowerShell as Administrator and run:

npm install -g zcrafter

Verifying Installation

After installation, verify that Zcrafter is installed correctly by typing:

zcrafter --version

You should see the version number displayed.

You can also check the help information by typing:

zcrafter --help

This displays all available commands and options.

Updating Zcrafter

To update Zcrafter to the latest version, type:

npm update -g zcrafter

Or reinstall:

npm uninstall -g zcrafter
npm install -g zcrafter

Uninstalling Zcrafter

To remove Zcrafter from your system, type:

npm uninstall -g zcrafter

Next Steps

After installation:

  1. Set your API key: export OPENROUTER_API_KEY="your-api-key"
  2. Learn about Using Zcrafter

Troubleshooting Installation

If you encounter issues during installation, see the Troubleshooting page for solutions to common problems, including:

  • Permission errors
  • Network issues
  • Node.js version problems