Newer
Older
cortex-hub / ai-hub / app / core / templates / provisioning / README.md.j2
# Cortex Agent Node

This bundle contains the Cortex Agent Node, a modular software that connects your physical computing resources to the Cortex Hub.

## Structure
- `bootstrap_installer.py`: The daemon & update installer
- `src/`: Core Python modules (`agent_node`, `protos`, `shared_core`)
- `run.sh` / `run.bat`: Simple execution wrappers

## Running the Node

### Fast/Production (macOS & Linux)
To run the node cleanly in the background as a daemon (survives system restarts):
1. Open a terminal in this directory.
2. Run: `python3 bootstrap_installer.py --daemon`

That's it! You can safely close your terminal.

### Debug / Foreground (macOS & Linux)
1. Open a terminal in this directory.
2. Make the runner executable: `chmod +x run.sh`
3. Run: `./run.sh`

### Windows
1. Double-click `run.bat`.

The scripts perfectly set up the python virtual environment.

## Configuration
The `agent_config.yaml` file natively holds your node's identity and secrets. Do not share it.