Getting Started

Getting Started with Zcrafter

Welcome to Zcrafter! This guide will walk you through the complete installation and setup process to get you up and running with your AI mainframe assistant.

Prerequisites

Zcrafter is built on Node.js, a powerful JavaScript runtime. Before installing Zcrafter, you need to ensure your system is ready.

1. Node.js

You must have Node.js installed. We recommend the Active LTS (Long Term Support) version for the best stability.

  • Minimum Version: Node.js 16
  • Recommended: Node.js 18 or 20

How to check: Open your terminal (Command Prompt on Windows) and type:

node --version

If you see a version number like v18.16.0, you are good to go. If you see "command not found", download it from nodejs.org (opens in a new tab).

2. Terminal

You need a command-line interface.

  • macOS: Terminal or iTerm2.
  • Windows: PowerShell or Command Prompt.
  • Linux: Any standard terminal (bash, zsh).

Installation

Zcrafter is distributed as an NPM package, making it easy to install on any operating system.

Step 1: Install the CLI

Run the following command in your terminal:

npm install -g zcrafter

The -g flag stands for "global", meaning Zcrafter will be installed as a system-wide command that you can run from anywhere.

Troubleshooting Permission Errors: If you see an EACCES error on macOS or Linux, it means you need administrative privileges. Try running:

sudo npm install -g zcrafter

Step 2: Verify Installation

Once the installation finishes, verify that Zcrafter is correctly installed:

zcrafter --version

You should see the version number (e.g., 3.1.36).

First-Time Setup

Zcrafter is designed to be "zero-config" to start. You don't need to edit any files manually.

  1. Launch Zcrafter: Simply type zcrafter in your terminal and press Enter.

  2. Interactive Wizard: On your first run, Zcrafter will present a friendly setup wizard.

    • Select Provider: Choose your preferred AI provider (OpenRouter, Anthropic, OpenAI, or Gemini).
    • Enter API Key: Paste your API key. (The input will be hidden for security).

  3. Mainframe Connection: After setting up the AI, Zcrafter may ask if you want to connect to a mainframe immediately.

    • Connect Now: Enter your Host, Port, User, and Password if you're ready to work.
    • Connect Later: Press Esc to skip this step. You can always connect later using Ctrl+M.

What's Next?

Congratulations! You have successfully installed Zcrafter. You are now dropped into the main chat interface.

  • Start Chatting: Ask a question like "How do I allocate a dataset?"
  • Explore Features: Learn about Mainframe Integration.
  • Master the Interface: Read our guide on Using Zcrafter.
IntroductionAPI Key Setup