Skip to content

GoodVision CLI ​

GoodVision CLI lets Codex discover and call GoodVision public APIs from your terminal. Inspect a capability and its parameters, preview the request, then execute authorized model, customer, subscription or order operations with structured results.

The product is GoodVision CLI; run goodvision or its shorthand gv. Package @goodvision/cli uses the same @goodvision npm scope and maintaining team as @goodvision/ui. The CLI and SDK are available from npm and can also be built from source.

Quick start ​

  1. Install the CLI from npm or build it from source.
  2. Configure identity for your application and environment. Choose user or service credentials according to the operation.
  3. Discover, preview and call your first API.
bash
goodvision api products
goodvision api search user context
goodvision schema resolveCustomerUserContext

Use cases ​

TaskAsk CodexCapabilities
First application integrationFind the user-context API, inspect its required Scopes and preview my sandbox request.Discovery, Schema, request preview
Model integrationInspect available model APIs and build code to query models and usage for my authorized context.Token APIs, SDK types
Customer operationsFind company, lead and quote operations. Show me the required references and a preview before changing anything.Customer APIs, product policies, idempotency
Event automationGenerate a receiver that persists subscribed events and acknowledges only after idempotent processing.Event SDK, SSE, Webhook templates

Capability map ​

Explore the business capability map for public domains, product IDs and guides. The Agent overview explains identity, interaction and execution layers and how to combine them.

Documentation ​

GoalGuide
Installation and first taskQuick start
Identity and credential checksAuthentication and configuration
Multiple applicationsProfiles
API discovery, preview and executionAPI calls
Event debugging and ACKEvents
Commands and machine-readable documentationCommand reference
Errors and recoveryFAQ
Application codeTypeScript SDK
New integration projectsTemplates

API registration, credential acquisition and business authorization are separate checks. QR application provisioning, terminal OAuth login/logout and a conversational Channel SDK are not implemented.

Developer documentation. Internal operations access is not required.