Nodie CLI - Turn your terminal into a network node and earn rewards
Project description
Nodie CLI
Turn your terminal into a network node. Earn rewards for sharing bandwidth.
🚀 Features
- Cross-Platform: Works on Windows, macOS, and Linux
- Headless Operation: Run as a background service or daemon
- Auto-Reconnect: Automatically reconnects if connection is lost
- Real-Time Stats: View your earnings and node statistics
- Low Resource Usage: Minimal CPU and memory footprint
📦 Installation
Using pip (Recommended)
pip install nodie-cli
Using pipx (Isolated Environment)
pipx install nodie-cli
From Source
git clone https://github.com/nodiehost/nodie-cli.git
cd nodie-cli
pip install -e .
🔧 Quick Start
1. Login to your account
nodie login
You'll be prompted for your email and password. Your credentials are stored securely.
2. Start the node
nodie start
3. Check your stats
nodie stats
4. Stop the node
nodie stop
📖 Commands
| Command | Description |
|---|---|
nodie login |
Login to your Nodie account |
nodie logout |
Logout and clear credentials |
nodie start |
Start the node and begin earning |
nodie stop |
Stop the running node |
nodie status |
Check if node is running |
nodie stats |
View your earnings and statistics |
nodie config |
View or update configuration |
nodie speedtest |
Run a network speed test |
nodie version |
Show version information |
⚙️ Configuration
Configuration file location:
- Linux/macOS:
~/.config/nodie/config.json - Windows:
%APPDATA%\nodie\config.json
Environment Variables
| Variable | Description | Default |
|---|---|---|
NODIE_API_URL |
API endpoint URL | https://nodie.host/api |
NODIE_CONFIG_DIR |
Config directory path | Platform default |
NODIE_LOG_LEVEL |
Logging level | INFO |
🖥️ Running as a Service
Linux (systemd)
# Create service file
sudo nodie install-service
# Enable and start
sudo systemctl enable nodie
sudo systemctl start nodie
macOS (launchd)
nodie install-service --user
Windows (Task Scheduler)
nodie install-service
🔒 Security
- Credentials are stored encrypted using your system's keyring
- All communication uses HTTPS
- No personal data or browsing history is collected
- Only bandwidth metrics are transmitted
📊 Earnings
Points are calculated based on:
- Connection Quality: Good (≥30 Mbps) = 0.5 pts/min, Bad (<30 Mbps) = 0.1 pts/min
- IP Type: Residential IPs earn full rate, Datacenter IPs earn 30%
- Uptime: The longer you run, the more you earn
🐛 Troubleshooting
Node won't connect
- Check your internet connection
- Verify your credentials:
nodie login - Check API status:
nodie status --verbose
Low points earnings
- Run speed test:
nodie speedtest - Ensure you have a residential IP (not VPN/datacenter)
- Keep the node running 24/7 for maximum earnings
🤝 Contributing
Contributions are welcome! Please read our Contributing Guide first.
# Clone the repository
git clone https://github.com/nodiehost/nodie-cli.git
cd nodie-cli
# Install development dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run linting
ruff check .
📄 License
MIT License - see LICENSE for details.
🔗 Links
- Website: https://nodie.host
- PyPI: https://pypi.org/project/nodie-cli/
- Documentation: https://nodie.host/docs
- Support: https://nodie.host/support
- Browser Extension: Chrome | Firefox
Made with ❤️ by the Nodie Team
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nodie_cli-1.0.1.tar.gz.
File metadata
- Download URL: nodie_cli-1.0.1.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e03d1cdf11e45ddae1553e36e87699aa1181764a0403fe5bf51661675040aaf
|
|
| MD5 |
237fb47b5b154b638516ef46b99a5876
|
|
| BLAKE2b-256 |
da182f1fdedbc503b555c062403a09155566137a24c079e2c39596bfc923dd84
|
File details
Details for the file nodie_cli-1.0.1-py3-none-any.whl.
File metadata
- Download URL: nodie_cli-1.0.1-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b3711cd3563561466256c85d168b6ba97b686260c37039ef21ffc775ec548c1d
|
|
| MD5 |
36c4af9fd96e7b01f8a0650e67864dc8
|
|
| BLAKE2b-256 |
1a1c1324b20b47e23bcf7a75daa58743c890daf70ea34d677a55c2cd2825752f
|