Get started

The command line

Your terminal.Your registry.

Inspect a record. Find a capability. Follow its history. Start with the HTTP API and tools already at home in your terminal.

  • Real HTTP workflows
  • No special client required
  • Your choice of registry
A closer lookA useful command. An inspectable result.

The command-line interface puts registry operations into scripts, terminals, and agent workflows.

  1. 01Choose the command
  2. 02Call the registry
  3. 03Inspect the response

01 / connect

Start with an address.

Point your shell at a registry you operate or have access to. These commands make real requests when you run them; this website does not execute them.

choose-a-registry
# Replace this example with your registry URL.
MARS_URL='https://your-registry.example'
curl --fail "$MARS_URL/v1/health"

02 / requests

One useful request at a time.

Keep the same base URL as you move from discovery to a specific entry and its history. Open a request to inspect and copy it.

Check the registry

Read the shallow public health endpoint. Protected deep health is a separate operator view.

request.sh
curl --fail "$MARS_URL/v1/health"

Find a capability

Run a bounded DISCOVER query against the registry you selected.

request.sh
curl --fail "$MARS_URL/v1/discover/marsql" \
  -H 'Content-Type: application/json' \
  --data '{"query":"DISCOVER AgentDefinition WHERE tags CONTAINS \"research\" LIMIT 10"}'

Resolve a record

Replace the example with an entry DID from your results. URL-encode the DID before using it as a path segment.

request.sh
ENTRY_DID_ENCODED='did%3Aoas%3Aexample%3Aagent%3Aresearch'
curl --fail "$MARS_URL/v1/entries/$ENTRY_DID_ENCODED"

Follow its history

Request a bounded, newest-first page of versions. Use the returned cursor to continue.

request.sh
curl --fail "$MARS_URL/v1/entries/$ENTRY_DID_ENCODED/versions?limit=10"

Inspect configured peers

Read the registry’s canonical peer list. Sync and discovery depend on the operator’s configuration.

request.sh
curl --fail "$MARS_URL/v1/federation/peers"

03 / publish

Go beyond a read.

Publishing, updating, revoking, attesting, and transferring use authenticated operations. Each action carries its own request type and authority.

  • Prepare the record

    Use canonical entry types, calculate the content hash, and sign publisher-authored fields with the expected profile.

  • Authorize the operation

    Establish the SIWS session, provide the required capability, and use a route-scoped idempotency key.

  • Choose your interface

    The reference binary is mars-server. Explore Reggie for a separate publisher-facing command line.

Explore request types and protected operations →