@suryastra/openpilot
v1.1.8
Published
OpenPilot CLI wrapper that downloads the native binary for your platform.
Readme
@suryastra/openpilot
OpenPilot CLI wrapper for Node.js that automatically downloads the native binary for your platform from GitHub Releases.
Quick Start
Global Installation
Install globally to use the openpilot command anywhere:
npm install -g @suryastra/openpilot
openpilot --helpOne-time Usage
Run without installing globally:
npx @suryastra/openpilot --helpProject Dependency
Add to your Node.js project:
npm install @suryastra/openpilotConfiguration
Environment variables for customization:
| Variable | Description | Default |
| ------------------- | -------------------------- | -------------------------- |
| OPENPILOT_VERSION | Pin a specific version | latest |
| OPENPILOT_REPO | Override GitHub repository | JyotirmoyDas05/openpilot |
| OPENPILOT_DEBUG | Enable verbose logging | 0 |
Version Pinning Example
OPENPILOT_VERSION=1.0.6 npx @suryastra/openpilot --versionHow It Works
- Postinstall: Downloads the appropriate binary archive from GitHub Releases
- Extraction: Unpacks and places the
openpilotbinary in the package bin directory - Execution: JavaScript shim spawns the native binary with your arguments
Platform Support
- Windows: x86_64, ARM64 (requires Windows 10+ with tar support)
- macOS: x86_64 (Intel), ARM64 (Apple Silicon)
- Linux: x86_64, ARM64
Troubleshooting
Common Issues
- Node.js Version: Requires Node.js 18 or higher
- Corporate Proxies: Set
HTTPS_PROXYenvironment variable if downloads are blocked - Windows Extraction: Requires
tarcommand (included in Git for Windows and Windows 10+)
Debug Mode
Enable detailed logging to troubleshoot download issues:
OPENPILOT_DEBUG=1 npm install @suryastra/openpilotManual Installation
If automatic download fails, manually download the binary:
- Visit GitHub Releases
- Download the appropriate archive for your platform
- Extract and place the binary as:
node_modules/@suryastra/openpilot/bin/openpilot[.exe]
License
See LICENSE.md in the project root.
