CLI Reference: Rizta DevKit¶

About this Sample

Goal: Provide a command-level reference for interacting with the Rizta DevKit CLI.
Key Skills: CLI documentation structure, command syntax design, parameter clarity, and mapping CLI actions to API behavior.

The Rizta CLI allows developers to interact with the Smart Vehicle Platform directly from the command line.

How the CLI maps to the API¶

Each CLI command corresponds to one or more API endpoints.

CLI Command	API Endpoint
`rizta auth --pair`	`POST /auth/pair`
`rizta status`	`GET /vehicles/{id}/status`
`rizta rides`	`GET /vehicles/{id}/rides`

For detailed request and response structures, see the API Reference.

Command structure¶

All commands follow this pattern:

rizta <command> [options]

<command> specifies the action
[options] modify behavior or provide required inputs

Global options¶

Option	Description
`--help`	Displays help for a command
`--version`	Shows CLI version
`--output json`	Formats output as JSON

Authentication Commands¶

Pair a vehicle¶

rizta auth --pair

Pairs your local CLI with a scooter using VIN-based authentication.

Options¶

Option	Required	Description
`--vin`	Yes	Vehicle Identification Number
`--profile`	No	Riding profile (`eco`, `zip`, `warp`)

Example¶

rizta auth --pair --vin "RIZTA123456" --profile warp

Output¶

{
  "status": "paired",
  "vehicle_id": "rizta_001",
  "profile": "warp"
}

Vehicle Commands¶

Get vehicle status¶

rizta status --vehicle-id <id>

Retrieves real-time vehicle telemetry including battery, range, and operational state.

Example¶

rizta status --vehicle-id "rizta_001"

Output¶

{
  "soc": 88,
  "range_km": 112,
  "status": "ready"
}

Get ride history¶

rizta rides --vehicle-id <id>

Returns recent ride sessions and statistics.

Example¶

rizta rides --vehicle-id "rizta_001"

Output¶

{
  "rides": [
    {
      "date": "2026-03-27",
      "distance_km": 24,
      "mode": "zip"
    }
  ]
}

Diagnostics Commands¶

Check vehicle health¶

rizta health --vehicle-id <id>

Provides diagnostic information about the vehicle system.

Output¶

{
  "motor_status": "optimal",
  "battery_health": "good",
  "alerts": []
}

Error Handling¶

CLI errors follow a structured format:

{
  "error_code": "string",
  "message": "Human-readable description",
  "resolution": "Suggested corrective action"
}

Common CLI Errors¶

Error	Cause	Resolution
`authentication_failed`	Invalid pairing session	Re-run `rizta auth --pair`
`vehicle_not_found`	Incorrect vehicle ID	Verify VIN and pairing
`rate_limited`	Too many requests	Reduce command frequency

About this sample

This documentation is a fictional example created as part of a technical writing portfolio.
It is not affiliated with or endorsed by Ather Energy.

References to the Ather Rizta and related systems are used purely for illustrative purposes to demonstrate documentation concepts and do not reflect actual product behavior.