Getting Started

This guide helps you install Zcrafter and start using it in minutes.

Prerequisites

Before you begin, make sure you have:

• Node.js 16 or higher (18 LTS or 20 LTS recommended)
• Internet access for AI features
• Terminal or command prompt access

Check your Node.js version:

node --version

If you need to install or upgrade Node.js, visit nodejs.org and download the LTS version.

Installation

Install Zcrafter globally using npm:

npm install -g zcrafter

If you encounter a permission error, use:

sudo npm install -g zcrafter

Verify installation

zcrafter --version

Set your API key

Zcrafter uses your OpenRouter API key. Set it as an environment variable:

export OPENROUTER_API_KEY="your-api-key"

To persist it, add the same line to your shell profile (for example, ~/.zshrc), then reload your shell:

source ~/.zshrc

First run

Start the interactive interface:

zcrafter

At the prompt, you can immediately ask questions or run commands. Examples:

Explain what COBOL is
Why did my job fail with S0C7

Interactive mode basics

In interactive mode, you can:

• Ask questions in natural language
• Use slash commands to perform actions
• View responses and iterate quickly

Next steps

1. Learn about Using Zcrafter
2. See Natural Language Commands
3. Explore Slash Commands

Common issues

Permission errors

sudo npm install -g zcrafter

Node.js version too old

Install an LTS version from nodejs.org and try again.