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


🚀 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/nicofirst1/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/nicofirst1/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


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.0.tar.gz (17.9 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.0-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nodie_cli-1.0.0.tar.gz
  • Upload date:
  • Size: 17.9 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.0.tar.gz
Algorithm Hash digest
SHA256 8b03fb324e1f62cc59d575256d9895046b4a9c779ecea4a37f6d418dc9e3db86
MD5 e5003896e0c0804aad8831bd89b23bc1
BLAKE2b-256 c985883bae8248c0f94713239f83ec999a42b9f5b7dcae7ff9a9f6fcd568a894

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nodie_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50de50dac28060b87b3d7ba49988163e434bb6283ab2a379e376bf1e015d4d3f
MD5 c6898b6a05dc116ee000c07878b1049a
BLAKE2b-256 68e42c0ff293e6c222c8bbefe2e0286da074e0777e95bf89d09529989f8ea661

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