Skip to main content

Docs Search

Search the Gravity Rail documentation from the command line with gr docs search. Results are ranked server-side, so you always get the latest content and improved rankings regardless of your CLI version.

Basic usage​

gr docs search -q "outbound workflow"

Output:

TITLE                                    URL
Outbound Workflows                       https://docs.gravityrail.com/...
Configuring Outbound SMS                 https://docs.gravityrail.com/...
Workflow Task Reference                  https://docs.gravityrail.com/...

Options​

FlagDescription
-q "<query>"Required. The search term or phrase.
-o jsonOutput results as JSON instead of a table.

JSON output​

Use -o json when scripting or piping results:

gr docs search -q "webhook signing" -o json
[
  {
    "title": "Webhooks",
    "url": "https://docs.gravityrail.com/developer/webhooks",
    "snippet": "Send signed webhook payloads to external systems...",
    "score": 0.92
  }
]

Authentication​

No login required. The documentation corpus is public, so gr docs search works without a gr login session and without specifying a workspace.