---
title: "Getting Started"
description: "Nexus OS is open source and welcomes contributions from the community. Follow standard Rust formatting ( cargo fmt ) Run clippy before submitting ( cargo clippy ) Write tests for new features Document public APIs with do"
resource: https://www.aiagents.nexus/docs/manual/contributing/getting-started
generated: { by: "process:nexus-agent-assets", at: 2026-09-07T09:13:03Z }
status: stable
---

# Contributing to Nexus OS

Nexus OS is open source and welcomes contributions from the community.

## Repository Structure

```
nexus-os/
├── src/
│   ├── main.rs          # Entry point
│   ├── cli.rs           # CLI argument parsing
│   ├── config.rs        # Configuration loading
│   ├── store.rs         # SQLite data layer
│   ├── commands.rs      # Agent lifecycle commands
│   ├── axis.rs          # AXIS trust verification
│   ├── broker.rs        # Broker routing engine
│   ├── cloudflare.rs    # Cloudflare API client
│   ├── edge.rs          # Edge deployment commands
│   └── dashboard.rs     # Web dashboard
├── tests/               # Integration tests
├── docs/                # Documentation source
├── Cargo.toml           # Rust dependencies
└── README.md
```

## Development Setup

```bash
# Clone the repository
git clone https://github.com/leonidas-esquire/nexus-os.git
cd nexus-os

# Build in debug mode
cargo build

# Run tests
cargo test

# Build release binary
cargo build --release
```

## Code Style

- Follow standard Rust formatting (`cargo fmt`)
- Run clippy before submitting (`cargo clippy`)
- Write tests for new features
- Document public APIs with doc comments
