Skip to main content

Installation

Install the ModelPilot npm package and get started in seconds.

Requirements

  • Node.js 16.0.0 or higher

    Check your version with node --version

  • npm, yarn, or pnpm package manager
  • Active ModelPilot account

    Sign up for free

Installation Methods

Using npm
Recommended for most projects
bash
npm install modelpilot
Using Yarn
bash
yarn add modelpilot
Using pnpm
bash
pnpm add modelpilot

Verify Installation

Quick Test
Verify the package is installed correctly
javascript
import ModelPilot from 'modelpilot';

console.log(ModelPilot);
// Should output: [class ModelPilot]

TypeScript Support

Built-in TypeScript Definitions

The ModelPilot package includes TypeScript definitions out of the box. No additional @types package needed.

Troubleshooting

Common Issues

Node.js version error

If you see errors about Node.js version, upgrade to Node.js 16 or higher:

bash
nvm install 18 nvm use 18

Permission errors

If you encounter EACCES or permission errors, use one of these solutions:

  • Use npx instead of global installation
  • Configure npm to use a different directory
  • Use a Node version manager (nvm)

Network/proxy issues

If behind a proxy or firewall, configure npm:

bash
npm config set proxy http://proxy.company.com:8080 npm config set https-proxy http://proxy.company.com:8080

Next Steps