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

# grid-nexus-client

> Python client for GRID Nexus

Python client for GRID Nexus — connect to a robot on the GRID network for direct command dispatch (`RemoteRobot`) or staged program deployment (`RemoteDeployment`), with live monitoring of the running graph.

## Install

```bash theme={null}
# Preinstalled in every GRID session workspace. For local use, install
# from the GRID package index with your organization's read-only
# credentials (the same pair `grid robot setup` provisions on robots):
export UV_INDEX_GRID_PYPI_USERNAME=<username>
export UV_INDEX_GRID_PYPI_PASSWORD=<token>
uv pip install grid-nexus-client --index grid-pypi=https://pypi.generalrobotics.dev/simple/
```

## Quickstart

```python theme={null}
from grid_nexus_client import connect
from grid_types import Velocity

# Direct dispatch: a RemoteRobot whose methods are the robot's capabilities.
robot = connect("<robot-name>")
robot.getState()

# standUp/moveByVelocity are a quadruped's; what any given robot
# exposes is its own — see Robot interface.
robot.standUp()
robot.moveByVelocity(Velocity(0.1, 0.0, 0.0), Velocity(0.0, 0.0, 0.0))
```

The methods a `RemoteRobot` exposes are the robot's own — see **Robot interface** for the catalog. The end-to-end walkthrough is [Your first skill](/get-started/first-skill).

## Classes

* [`RemoteRobot`](/python-api/grid-nexus-client/remoterobot)
* [`RemoteDeployment`](/python-api/grid-nexus-client/remotedeployment)
* [`MonitorClient`](/python-api/grid-nexus-client/monitorclient)
* [`MonitorScope`](/python-api/grid-nexus-client/monitorscope)
* [`MonitorSnapshot`](/python-api/grid-nexus-client/monitorsnapshot)
* [`TraceReference`](/python-api/grid-nexus-client/tracereference)
* [`BlockStepSubscription`](/python-api/grid-nexus-client/blockstepsubscription)
* [`BlockStep`](/python-api/grid-nexus-client/blockstep)
* [`FailedStep`](/python-api/grid-nexus-client/failedstep)
* [`GraphNodeStatus`](/python-api/grid-nexus-client/graphnodestatus)
* [`PartyInstance`](/python-api/grid-nexus-client/partyinstance)
* [`MonitorEvent`](/python-api/grid-nexus-client/monitorevent)
* [`SessionState`](/python-api/grid-nexus-client/sessionstate)
* [`HealthStatus`](/python-api/grid-nexus-client/healthstatus)
* [`GridEndpointProfile`](/python-api/grid-nexus-client/gridendpointprofile)

## Functions

* [`connect`](/python-api/grid-nexus-client/connect)
* [`observe`](/python-api/grid-nexus-client/observe)
* [`resolve_grid_profile`](/python-api/grid-nexus-client/resolve_grid_profile)


## Related topics

- [connect](/python-api/grid-nexus-client/connect.md)
- [Robot interface](/python-api/robot-interface/overview.md)
- [GRID Cortex Client](/models/cortex.md)
- [grid-cortex-client](/python-api/grid-cortex-client/overview.md)
- [RemoteDeployment](/python-api/grid-nexus-client/remotedeployment.md)
