New protocol version released: This page may contain outdated information.
Prerequisites
Node.js
Version 20.0.0 or higher
npm
Version 9.0.0 or higher
Git
For cloning the repository
Source installation
Installing from source is recommended.1
Clone the Repository
2
Install Dependencies
3
Build the Project
4
Verify Installation
Optional: Install Globally
npm installation
Available Now: The HAIP CLI is available on npm as
@haip/cli.Docker installation
Docker: Docker images will be available on Docker Hub as
haip/cli in the future.Pull the Image
Run the Container
Development Setup
Prerequisites for Development
- Node.js 20.0.0 or higher
- npm 9.0.0 or higher
- TypeScript 5.0.0 or higher
- Git for version control
Development Installation
Development Mode
Verification
After installation, verify that the CLI is working correctly:Check version
System information
Help system
Test commands
Configuration
Environment Variables
The CLI can be configured using environment variables:Configuration file
Configuration files are a planned enhancement. Create a configuration file for persistent settings:Troubleshooting
Common Issues
Permission Denied
Node Version Issues
Build Errors
Test Failures
Getting Help
If you encounter issues:- Check the logs - Run with verbose output:
node dist/index.js --verbose - Check Node.js version - Ensure you’re using Node.js 16+
- Check dependencies - Run
npm installto ensure all dependencies are installed - Check TypeScript - Run
npx tsc --noEmitto check for type errors - Check tests - Run
npm testto ensure everything is working
Next Steps
- Quick Start - Get up and running quickly
- Command Reference - Learn about available commands
- Configuration - Configure the CLI
- Examples - See usage examples