> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peaq.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# peaqOS

peaqOS is the operating system that turns robots and machines into financial assets and economic actors. It gives every machine the identity, credit, and onchain rails to be underwritten, owned, traded, and access markets in its own right.

<CardGroup cols={2}>
  <Card title="Install" icon="download" href="/quickstart">
    Register your first machine in five minutes.
  </Card>

  <Card title="Roadmap" icon="map" href="/roadmap">
    See what ships next.
  </Card>
</CardGroup>

## Quickstart

<Tabs>
  <Tab title="Agent skill">
    Let a coding agent drive the integration. The peaqOS skill walks any AI agent through machine registration, MCR queries, fleet management, and troubleshooting end to end.

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    pip install peaq-os-cli
    npx skills add peaqnetwork/peaq-os-skills
    ```
  </Tab>

  <Tab title="CLI">
    Scripted on the terminal. One command registers your first machine.

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    pip install peaq-os-cli
    peaqos init && peaqos activate --doc-url "https://example.com/docs" --data-api "https://example.com/events"
    ```

    Full command reference on the [peaqOS CLI page](/peaqos/cli).
  </Tab>

  <Tab title="JavaScript">
    Node ≥ 22, TypeScript ≥ 5, `viem` peer dependency.

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    npm install @peaqos/peaq-os-sdk viem dotenv
    ```

    ```typescript theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    import "dotenv/config";
    import { PeaqosClient } from "@peaqos/peaq-os-sdk";

    const client = PeaqosClient.fromEnv();

    // Self-managed: the client's own keypair registers as the machine
    const machineId = await client.registerMachine();

    console.log("Registered machine:", machineId);
    ```

    Full walkthrough on [self-managed onboarding](/peaqos/guides/self-managed-onboarding).
  </Tab>

  <Tab title="Python">
    Python ≥ 3.10, `web3.py` dependency.

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    pip install peaq-os-sdk python-dotenv
    ```

    ```python theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    from dotenv import load_dotenv
    load_dotenv()

    from peaq_os_sdk import PeaqosClient

    client = PeaqosClient.from_env()

    # Self-managed: the client's own keypair registers as the machine
    machine_id = client.register_machine()

    print("Registered machine:", machine_id)
    ```

    Full walkthrough on [self-managed onboarding](/peaqos/guides/self-managed-onboarding).
  </Tab>

  <Tab title="ROS 2">
    Humble or Jazzy. Wraps the SDKs as ROS 2 services so a robot becomes an on-chain machine actor without leaking keys through ROS messages.

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    git clone https://github.com/peaqnetwork/peaq-robotics-ros2.git
    cd peaq-robotics-ros2
    source /opt/ros/jazzy/setup.bash
    colcon build --packages-select \
      peaq_ros2_interfaces peaq_ros2_peaqos peaq_ros2_examples
    source install/setup.bash
    ```

    ```bash theme={"theme":{"light":"github-light-default","dark":"github-dark"}}
    # Self-managed: register the local machine wallet
    ros2 service call /peaqos_node/machine/register \
      peaq_ros2_interfaces/srv/PeaqosRegisterMachine \
      "{address: '<MACHINE_EVM_ADDRESS>'}"
    ```

    Full reference on [ROS 2](/peaqos/sdk-reference/ros2/overview).
  </Tab>
</Tabs>

## Who it's for

<CardGroup cols={3}>
  <Card title="For builders" icon="code" href="/peaqos/functions/activate">
    Integrate peaqOS. Give your machines identity, credit ratings, and financial infrastructure.
  </Card>

  <Card title="For operators" icon="layer-group" href="/peaqos/guides/proxy-operator-fleet">
    Register your fleet. One proxy, every machine on-chain.
  </Card>

  <Card title="For capital allocators" icon="chart-line" href="/peaqos/api-reference/overview">
    Query any machine's credit rating. Any chain. One API call.
  </Card>
</CardGroup>

## Functions

<CardGroup cols={3}>
  <Card title="Activate" icon="bolt" href="/peaqos/functions/activate">
    **LIVE**

    Put your machine on-chain. DID, wallet, Machine NFT, bond.
  </Card>

  <Card title="Qualify" icon="gauge" href="/peaqos/functions/qualify">
    **LIVE**

    Credit rate your machine from its revenue and activity history.
  </Card>

  <Card title="Scale" icon="network-wired" href="/peaqos/functions/scale">
    **Coming Soon**

    Pair an AI agent that transacts and consumes services on your machine's behalf.
  </Card>

  <Card title="Verify" icon="shield-check" href="/peaqos/functions/verify">
    **Coming Soon**

    Prove your machine is real via hardware attestation and trusted third parties.
  </Card>

  <Card title="Monetize" icon="coins" href="/peaqos/functions/monetize">
    **Coming Soon**

    List your machine's services. Other machines and agents discover and buy them.
  </Card>

  <Card title="Tokenize" icon="layer-group" href="/peaqos/functions/tokenize">
    **Coming Soon**

    Fractionalize your machine into an investable asset via ERC-3643.
  </Card>
</CardGroup>

## Keep going

<CardGroup cols={4}>
  <Card title="Roadmap" icon="map" href="/roadmap">
    What ships when.
  </Card>

  <Card title="API reference" icon="code" href="/peaqos/api-reference/overview">
    Query MCR from any chain.
  </Card>

  <Card title="GitHub" icon="github" href="https://github.com/peaqnetwork">
    Source and SDKs.
  </Card>

  <Card title="Discord" icon="discord" href="https://www.discord.gg/peaqnetwork">
    Builders, operators, OEMs.
  </Card>
</CardGroup>