Skip to main content

Nodie CLI - Turn your terminal into a network node and earn rewards

Project description

Nodie CLI

Nodie Logo

Turn your terminal into a network node. Earn rewards for sharing bandwidth.

PyPI version Python versions License Downloads


🚀 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

  1. Check your internet connection
  2. Verify your credentials: nodie login
  3. Check API status: nodie status --verbose

Low points earnings

  1. Run speed test: nodie speedtest
  2. Ensure you have a residential IP (not VPN/datacenter)
  3. 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


Nodie

Made with ❤️ by the Nodie Team

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nodie_cli-1.0.2.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nodie_cli-1.0.2-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file nodie_cli-1.0.2.tar.gz.

File metadata

  • Download URL: nodie_cli-1.0.2.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

Hashes for nodie_cli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 45c094c5df356b58ef984b8273a3ccd648dbda6a6acd4f989f3963a66132db36
MD5 4811428dc5f8b2a735eb042ac618594a
BLAKE2b-256 120a4bc0c2b4e9b3cacb5c4da44a9b5eb6666ab8705c2116b50da93fb6dc45ac

See more details on using hashes here.

File details

Details for the file nodie_cli-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: nodie_cli-1.0.2-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

Hashes for nodie_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 717f0b8264bf136d52ac50ae6b6efe901f271c55ab76c0937b5a7ccd6deac6cc
MD5 83fe3915e777eb870443f62c0e1e92cb
BLAKE2b-256 f77a8fe1417d4808ef80f64d2640127b09d6cb7c6330c592ec0ca333919b190d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page