UNPKG

seb-cli-tool

Version:

SEB CLI - Smart Embedded Board Configuration Tool - Cloud-First MCU Management

181 lines (133 loc) 4.45 kB
# SEB CLI - Installation Guide ## 🚀 Quick Installation SEB CLI is a closed-source, proprietary tool distributed via npm. Follow these steps to install: ### Prerequisites - **Windows**: Node.js 14.0.0 or higher, npm 6.0.0 or higher - **macOS**: Node.js 14.0.0 or higher, npm 6.0.0 or higher - **Linux**: Node.js 14.0.0 or higher, npm 6.0.0 or higher ### Supported Platforms - **Windows 10/11** (x64, ARM64) - **macOS 10.15+** (Intel, Apple Silicon) - **Linux** (Ubuntu 18.04+, CentOS 7+, Debian 9+) ### 1. Install SEB CLI ```bash # Install globally from npm npm install -g seb-cli-tool # Verify installation seb --version ``` ### 2. First Run Setup ```bash # Initialize SEB CLI seb registry status # Discover available MCUs seb registry boards # Create your first project seb init stm32f103c8t6 my-first-project ``` ## 🔒 Security & Licensing ### Source Code Protection - **Compiled Binary**: All business logic is compiled into a binary for source protection - **Cloud-First**: MCU definitions and updates are managed via cloud - **Proprietary License**: Commercial use requires license ### Data Privacy - **Anonymous Analytics**: Usage data is collected anonymously for product improvement - **No Personal Data**: No personal information is collected or stored - **Opt-out Available**: Analytics can be disabled if desired ## ☁️ Cloud Features ### Automatic Updates - **Background Checks**: SEB CLI checks for updates every hour - **Cloud-Managed**: Updates are controlled via cloud API - **Non-Blocking**: Update checks don't interfere with CLI usage ### Cloud Registry - **MCU Definitions**: All MCU configurations stored in cloud - **Always Updated**: Latest MCU definitions automatically available - **Offline Cache**: Downloaded configurations cached locally ### LLM Integration - **Cloud-Powered AI**: Natural language processing via cloud - **No API Keys**: Users don't need to manage API keys - **Graceful Fallback**: Works offline with pattern matching ## 🔧 Configuration ### Analytics Settings ```bash # View current configuration seb registry status # Analytics is enabled by default # To disable (not recommended): # Edit ~/.seb/config.json and set "analytics_enabled": false ``` ### Update Settings - **Automatic**: Updates checked every hour - **Manual**: Run `npm update -g seb-cli-tool` to update - **Test**: Use `seb registry test` to verify connectivity ## 🚨 Troubleshooting ### Common Issues **Installation Fails** ```bash # Clear npm cache npm cache clean --force # Reinstall npm uninstall -g seb-cli-tool npm install -g seb-cli-tool ``` **Cloud Connection Issues** ```bash # Check internet connection curl https://hideout-cli.onrender.com # Test registry connection seb registry test # Reset to cloud mode (if using local development setup) seb reset ``` **Platform-Specific Issues** **Windows:** ```bash # If PowerShell execution policy blocks scripts Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser # If virtual environment creation fails npm run setup-windows # If Python not found, check common installation paths: # - C:\Python310\python.exe # - C:\Python311\python.exe # - C:\Users\[username]\AppData\Local\Programs\Python\Python310\python.exe # If pip installation fails # 1. Run as Administrator # 2. Check antivirus is not blocking # 3. Try: pip install --upgrade pip # If binary not found, check PATH where seb # For detailed Windows installation guide, see: docs/WINDOWS_INSTALLATION.md ``` **macOS:** ```bash # If Gatekeeper blocks the binary sudo xattr -rd com.apple.quarantine /usr/local/bin/seb # If permission denied sudo chmod +x /usr/local/bin/seb ``` **Linux:** ```bash # If binary not executable chmod +x /usr/local/bin/seb # If library dependencies missing sudo apt-get install libc6-dev # Ubuntu/Debian sudo yum install glibc-devel # CentOS/RHEL ``` **Update Issues** ```bash # Force update check seb registry status # Skip update check seb registry test ``` ## 📞 Support ### Documentation - **GitHub**: https://github.com/samxdeadbeef/hideout-cli - **Issues**: Report bugs via GitHub Issues - **Discussions**: Community support via GitHub Discussions ### Commercial Support - **Email**: contact@rootaccess.ai - **Licensing**: Inquiries about commercial licensing - **Enterprise**: Custom deployments and support --- **SEB CLI**: Making embedded development as simple as `npm install -g seb-cli-tool` 🚀