### Start Observability Profile Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Use this command to start the observability profile alongside the default development stack. This command is idempotent. ```bash pnpm dev:observability ``` -------------------------------- ### Run Composition Service from Source Source: https://github.com/graphql-hive/console/blob/main/packages/services/external-composition/federation-2/README.md Steps to run the composition service directly from source code. This involves installing dependencies and starting the service using 'pnpm dev'. ```bash cd packages/services/external-composition/federation-2 pnpm install export SECRET="MY_SECRET_HERE" pnpm dev ``` -------------------------------- ### Start Docker Compose with Observability Profile Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Use this command to start the entire development stack, including the observability profile, from scratch. This command is idempotent. ```bash docker compose -f docker/docker-compose.dev.yml --profile observability up -d --remove-orphans ``` -------------------------------- ### Start Proxies for GitHub App Development Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Start separate Loophole proxies for the web application and the server to enable local development and testing of the GitHub integration. ```sh $ loophole http 3000 --hostname hive- ``` ```sh $ loophole http 3001 --hostname hive- ``` -------------------------------- ### Example .env File for Local Development Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md A minimal .env file configuration for local development. Ensure this file is created in the root of the repository. ```dotenv ENVIRONMENT=local ``` -------------------------------- ### Build and Run E2E Docker Environment Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute a local script to build the project and start Docker containers for E2E testing. ```bash ./local.sh ``` -------------------------------- ### Install Hive CLI with npm/yarn/pnpm Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Install the Hive CLI as a dev dependency in your NodeJS project using your preferred package manager. ```bash pnpm install -D @graphql-hive/cli ``` ```bash yarn add -D @graphql-hive/cli ``` ```bash npm install -D @graphql-hive/cli ``` -------------------------------- ### Start Docker Compose for E2E Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Run Docker Compose with community and E2E specific configurations to set up the environment for end-to-end tests. ```bash docker compose \ -f ./docker/docker-compose.community.yml \ -f ./docker/docker-compose.end2end.yml \ --env-file ./integration-tests/.env \ up -d --wait ``` -------------------------------- ### Run Integration Tests with Docker Compose Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute integration tests using the Docker Compose setup. ```bash pnpm --filter integration-tests test:integration ``` -------------------------------- ### Running the OTEL Trace Stress Test Source: https://github.com/graphql-hive/console/blob/main/load-tests/otel-traces/README.md Example command to execute the k6 load test for OTEL traces. Replace placeholder values with your actual credentials and target reference. ```sh OTEL_ENDPOINT=https://api.hiveready.dev/otel/v1/traces \ HIVE_ORGANIZATION_ACCESS_TOKEN="" \ HIVE_TARGET_REF="the-guild/hive/dev" \ k6 run load-tests/otel-traces/test.ts ``` -------------------------------- ### Start Loophole Proxy for Slack App Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Start a local proxy using Loophole to expose your local development server. This is used for Slack app development to create a publicly accessible hostname. ```sh $ loophole http 3000 --hostname hive- ``` -------------------------------- ### Reinstall Dependencies Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Installs all project dependencies using pnpm, typically performed after cleaning or modifying the project structure. ```bash pnpm install ``` -------------------------------- ### Install Hive CLI Binary Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Download the prebuilt binary of the Hive CLI for non-JavaScript projects using a curl command. ```bash curl -sSL https://graphql-hive.com/install.sh | sh ``` -------------------------------- ### Start Docker Compose for Integration Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Use Docker Compose to run all local services for integration testing, specifying registry and tag. ```bash export DOCKER_REGISTRY="ghcr.io/graphql-hive/" export DOCKER_TAG=":IMAGE_TAG_HERE" docker compose -f ./docker/docker-compose.community.yml -f ./integration-tests/docker-compose.integration.yaml --env-file ./integration-tests/.env up -d --wait ``` -------------------------------- ### Interactively Update Hive CLI Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Use this command to interactively select and install a version of the Hive CLI. This option is ignored if a channel is provided. ```bash $ hive update --interactive ``` -------------------------------- ### Live Alerts Demo Script Output Source: https://github.com/graphql-hive/console/blob/main/scripts/seed-alerts-live/README.md This output shows the sequence of events during the live alerts demo setup and execution. It includes preflight checks, organization provisioning, readiness confirmation, and the main loop's simulation of alert states (BREACH, NORMAL) and webhook events. ```text πŸ” Preflight checks… βœ“ Port 9999 free βœ“ API server reachable βœ“ Usage service reachable πŸ“‘ Webhook receiver listening on http://localhost:9999 πŸš€ Provisioning demo org for live-alerts-demo-1715520000000@localhost.localhost… βœ“ Organization: live-alerts-demo-1715520000000 βœ“ Feature flag metricAlertRules=true βœ“ Project: demo, target: production βœ“ Schema published βœ“ Webhook channel created βœ“ 7 rules created βœ“ Pre-seeded ~60s of breach data β”Œβ”€ Demo ready ─────────────────────────────────────── β”‚ Email: live-alerts-demo-1715520000000@localhost.localhost β”‚ Open in UI: http://localhost:3000/live-alerts-demo-1715520000000/demo/production/alerts/rules β”‚ β”‚ The alerts pages refresh every 15s. The cron evaluator β”‚ runs every minute. Expect the first NORMAL β†’ PENDING β†’ β”‚ FIRING transitions for rules 1, 5, 6, 7 within ~1-2 minutes β”‚ and rule 3 (with confirmationMinutes=1) within ~2 minutes. └──────────────────────────────────────────────────── β–Ά Starting main loop. Press Ctrl+C to stop. [14:23:01] ═══ injecting=BREACH for ~3min ════════════════════════════════════════════ expect: rules 1,5,6,7 β†’ FIRING within ~2 ticks; rule 2 transient PENDING then NORMAL (PERCENTAGE_CHANGE settles to 0); rule 3 β†’ PENDING then FIRING (confirm 1m); rule 4 β†’ recovers [14:23:01] tick 0 β€” pushed 20 ops (50% errors, p95=2000ms) [14:23:06] tick 1 β€” pushed 20 ops (50% errors, p95=2000ms) … [14:26:01] ═══ injecting=NORMAL for ~3min ════════════════════════════════════════════ expect: rules 1,5,6,7 β†’ RECOVERING then NORMAL; rule 4 β†’ FIRING (zero traffic falls below its 10/min floor); rule 3 β†’ RECOVERING then NORMAL [14:26:01] tick 0 β€” no traffic injected (silence is the breach for rule 4) [14:26:06] tick 1 β€” no traffic injected (silence is the breach for rule 4) … πŸ“¨ [2026-05-12T14:25:12.000Z] webhook POST /alert { "state": "firing", "alert": { "name": "Traffic spike (> 50 req/min)", "type": "TRAFFIC", … }, "currentValue": 240, … } ``` -------------------------------- ### Fast Iteration Configuration for Seed Script Source: https://github.com/graphql-hive/console/blob/main/scripts/seed-insights-and-alerts/README.md Use environment variables to limit the scope of seeded data for faster iteration during development. This example limits seeded days and rules. ```sh SEED_DAYS_PAST=3 SEED_RULE_LIMIT=3 pnpm seed:insights-and-alerts ``` -------------------------------- ### OOMKilling Event Details Source: https://github.com/graphql-hive/console/blob/main/docker/configs/otel-collector/benchmark.md Example log entries indicating Out Of Memory (OOM) killing events for the otelcol-custom process, showing high anonymous RSS memory usage. ```log Warning OOMKilling - Killed process 3482961 (otelcol-custom) total-vm: 5198444kB, anon-rss: 3973784kB (~3.9GB) Warning OOMKilling - Killed process 3466495 (otelcol-custom) total-vm: 5266984kB, anon-rss: 4050048kB (~4.0GB) Warning OOMKilling - Killed process 2448002 (otelcol-custom) total-vm: 5268200kB, anon-rss: 4000116kB (~4.0GB) ``` -------------------------------- ### Prepare Integration Environment Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Build a Docker image for services to prepare the environment for integration tests. ```bash pnpm integration:prepare ``` -------------------------------- ### Run Built Composition Service Source: https://github.com/graphql-hive/console/blob/main/packages/services/external-composition/federation-2/README.md Instructions to run the pre-built composition service. This involves building the project and executing the main JavaScript file. ```bash cd packages/services/external-composition/federation-2 pnpm build export SECRET="MY_SECRET_HERE" node dist/index.js ``` -------------------------------- ### Run Seed Alerts Live Source: https://github.com/graphql-hive/console/blob/main/scripts/seed-alerts-live/README.md Execute the primary command to seed alerts and set up the live environment. Stop the script with Ctrl+C. The created organization persists for inspection. ```sh pnpm seed:alerts-live ``` -------------------------------- ### Prepare Local Environment for Integration Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Build only the addition and local CF Workers source code for integration tests. ```bash pnpm --filter integration-tests prepare:env ``` -------------------------------- ### Run Integration Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute integration tests after preparing the environment. ```bash pnpm test:integration ``` -------------------------------- ### Run Integration Tests from Source Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute integration tests against locally running services during development. ```bash pnpm dev:integration ``` -------------------------------- ### Run All Unit Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute all unit tests locally using the pnpm test command. ```bash pnpm test ``` -------------------------------- ### Seed Organization with Projects and Users Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Optional command to seed a local organization with numerous projects and users. Ensure Hive and its ingestor are running. ```bash pnpm seed:org ``` -------------------------------- ### Run Composition Service with Docker Source: https://github.com/graphql-hive/console/blob/main/packages/services/external-composition/federation-2/README.md Use this command to run the composition service as a Docker container. Ensure you set the SECRET environment variable for security. ```bash docker run -p 3069 -e SECRET="MY_SECRET_HERE" ghcr.io/graphql-hive/composition-federation-2 ``` -------------------------------- ### Percentage-Based Memory Limiter Configuration Source: https://github.com/graphql-hive/console/blob/main/docker/configs/otel-collector/benchmark.md Configure the memory limiter using a percentage of available memory. This configuration failed due to OOM events during the benchmark. ```yaml memory_limiter: check_interval: 1s limit_percentage: 80 spike_limit_percentage: 20 ``` -------------------------------- ### Hive CLI Help Command Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Displays help information for the Hive CLI and its commands. Use the -n flag to include nested commands. ```bash USAGE $ hive help [COMMAND...] [-n] ARGUMENTS [COMMAND...] Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for hive. ``` -------------------------------- ### Create New Custom Migration Source: https://github.com/graphql-hive/console/blob/main/packages/migrations/README.md Use this command to generate a new custom migration file. Specify the desired name and allow custom extensions if needed. ```bash pnpm migration:create --name "do_something.mts" --allow-extension ".mts" ``` -------------------------------- ### Configure Usage Seeding Parameters Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Allows customization of the usage seeding process by setting the amount of operations per interval and the interval frequency. Also configurable is the total number of batches before the seed exits. ```bash INTERVAL=1000 OPERATIONS=1000 pnpm seed:usage ``` ```bash BATCHES=20 pnpm seed:usage ``` -------------------------------- ### Fetch Artifacts from CDN Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md This command allows fetching artifacts like SDL, supergraph, or metadata from the CDN. Specify the artifact type and optionally provide CDN endpoint, access token, or an output file path. ```bash hive artifact:fetch --artifact sdl|supergraph|metadata|services|sdl.graphql|sdl.graphqls [--debug] [--cdn.endpoint ] [--cdn.accessToken ] [--outputFile ] ``` -------------------------------- ### Check Available Hive CLI Versions Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Use this command to see a list of available versions for updating the Hive CLI. ```bash $ hive update --available ``` -------------------------------- ### Seed Schemas for Local Hive Instance Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Seeds your local Hive instance with a dummy schema. Requires a running Hive instance, ingestor, and a valid access token and target ID. ```bash FEDERATION=<0|1> TOKEN= TARGET= pnpm seed:schemas ``` -------------------------------- ### Run E2E Tests with Playwright Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute end-to-end tests using Playwright after setting up the Docker environment. ```bash pnpm test:e2e ``` -------------------------------- ### Build Docker Image for GraphQL Hive Source: https://github.com/graphql-hive/console/blob/main/packages/web/app/README.md Builds the Docker image for the GraphQL Hive application. Ensure you have built the monorepository first using 'pnpm build'. ```bash docker build . --build-arg RELEASE=stable-main -t graphql-hive/app ``` -------------------------------- ### Configure Local Hive Server to Use Mocked CDN Source: https://github.com/graphql-hive/console/blob/main/packages/services/cdn-worker/README.md Set the `CF_BASE_PATH` environment variable in your `packages/server/.env` file to point to your locally running CDN Worker. This ensures your local Hive instance communicates with the mocked CDN. ```dotenv CF_BASE_PATH=http://localhost:4010 ``` -------------------------------- ### Workflow Service Structure Overview Source: https://github.com/graphql-hive/console/blob/main/packages/services/workflows/README.md This snippet outlines the directory structure for the Workflow Service, indicating the locations for webhook payload models, task definitions, and general library code. ```bash # Definition of Webook Payload Models using zod src/webhooks/* # Task Definitions src/tasks/* # General lib src/lib/* ``` -------------------------------- ### Run Local E2E Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Execute end-to-end tests locally against development services. ```bash pnpm test:e2e:local ``` -------------------------------- ### Run Trace Seeding Script Source: https://github.com/graphql-hive/console/blob/main/scripts/seed-traces/README.md Execute the Node.js script to seed trace data. Ensure you have set the necessary environment variables for organization access token and target reference. You can also customize the seeding duration and reporting interval. ```bash HIVE_ORGANIZATION_ACCESS_TOKEN=hvo1/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= \ HIVE_TARGET_REF=the-guild/otel-demo/development \ node --experimental-strip-types seed-traces.mts ``` -------------------------------- ### Configure Server Environment Variables for GitHub Integration Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Set these environment variables in the server's .env file to enable GitHub integration. You will need your GitHub App ID and private key. ```dotenv INTEGRATION_GITHUB=1 INTEGRATION_GITHUB_GITHUB_APP_ID= ``` -------------------------------- ### Retire an App Deployment Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Use this command to retire a specific application deployment. You must provide the app name and version. Optional flags include enabling debug output, specifying registry details, and forcing retirement. ```bash hive app:retire --name --version [--debug] [--registry.endpoint ] [--registry.accessToken ] [--target ] [--force] ``` -------------------------------- ### OIDC/Social Provider Login Flow Diagram Source: https://github.com/graphql-hive/console/blob/main/packages/services/server/src/supertokens-at-home/README.md Visualizes the step-by-step process for user authentication using OIDC or social providers, from initial user interaction to session establishment. ```mermaid sequenceDiagram participant Browser participant Frontend App participant Backend Server participant OIDC Provider Browser->>Frontend App: 1. User clicks "Login with Google/GitHub/etc." Frontend App->>Backend Server: 2. Requests the provider's authorization URL (e.g., GET /auth/oidc/authorization-url) note right of Backend Server: The backend generates and stores a
`state` value and a `pkce_verifier`
for security. The `code_challenge`
(derived from the verifier) is part of the URL. Backend Server-->>Frontend App: 3. Responds with the unique authorization URL Frontend App->>Browser: 4. Redirects the browser to the OIDC Provider's URL Browser->>OIDC Provider: 5. User logs in with their credentials and grants consent to your application OIDC Provider->>Browser: 6. Redirects back to your app's callback URL with an `authorization_code` and the `state` value Browser->>Frontend App: 7. The Frontend App loads, capturing the `code` and `state` from the URL parameters Frontend App->>Backend Server: 8. Sends the `authorization_code` and `state` to the backend callback endpoint (e.g., POST /auth/oidc/callback) note right of Backend Server: The backend first validates that the received `state`
matches the one it stored earlier to prevent CSRF attacks. Backend Server->>OIDC Provider: 9. Exchanges the `code` for tokens (includes `code`, `client_secret`, and the original `pkce_verifier`) OIDC Provider-->>Backend Server: 10. Verifies the request and returns an `access_token` and `id_token` Backend Server->>OIDC Provider: 11. Uses the `access_token` to request the user's identity from a `/userinfo` endpoint OIDC Provider-->>Backend Server: 12. Returns the user's profile information (e.g., email, name, ID) note right of Backend Server: The backend now has trusted information about the user. Backend Server->>Backend Server: 13. Finds an existing user or creates a new one in its database and creates a new session Backend Server-->>Frontend App: 14. Responds with success and attaches the session cookies (`sAccessToken`, `sRefreshToken`) to the response Frontend App->>Browser: 15. The login is complete. The browser now stores the session cookies, and the user is authenticated within your application. ``` -------------------------------- ### Seed Usage Data for Local Hive Instance Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Generates dummy usage data for your local Hive instance to facilitate end-to-end testing. Requires a running Hive instance, ingestor, and a valid access token and target ID. ```bash FEDERATION=<0|1> TOKEN= TARGET= pnpm seed:usage ``` -------------------------------- ### hive app:create OPERATIONS Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Creates a new app deployment. This command takes a path to persisted operations or GraphQL files and allows specifying app name, version, target, and whether to publish the deployment. ```APIDOC ## `hive app:create OPERATIONS` ### Description Creates a new app deployment. This command takes a path to persisted operations or GraphQL files and allows specifying app name, version, target, and whether to publish the deployment. ### Method CLI Command ### Endpoint N/A (CLI Command) ### Parameters #### Arguments - **OPERATIONS** (string) - Required - Path to the persisted operations manifest (JSON file), a directory containing .graphql files, or a glob pattern matching .graphql files. #### Flags - **--name** (string) - Required - App name. - **--version** (string) - Optional - App version. - **--target** (string) - Optional - The target in which the app deployment will be created. This can either be a slug following the format "$organizationSlug/$projectSlug/$targetSlug" (e.g "the-guild/graphql-hive/staging") or an UUID (e.g. "a0f4c605-6541-4350-8cfe-b31f21a4bf80"). - **--publish** (boolean) - Optional - Publish the app deployment after creation. - **--debug** (boolean) - Optional - Whether debug output for HTTP calls and similar should be enabled. - **--registry.endpoint** (string) - Optional - Registry endpoint. - **--registry.accessToken** (string) - Optional - Registry access token. ### Request Example ```bash hive app:create OPERATIONS --name "my-app" --version "1.0.0" --target "my-org/my-project/staging" ``` ### Response #### Success Response - App deployment created successfully. #### Response Example (No specific response example provided in source) ``` -------------------------------- ### Run Seed Alerts Live in Data-Driver-Only Mode Source: https://github.com/graphql-hive/console/blob/main/scripts/seed-alerts-live/README.md Execute the script skipping pre-created rules, useful for manual rule creation via the UI. The script still provisions the organization and runs traffic loops. ```sh pnpm seed:alerts-live --no-rules ``` -------------------------------- ### Set Docker Environment Variables for E2E Tests Source: https://github.com/graphql-hive/console/blob/main/docs/TESTING.md Define Docker registry and tag as environment variables for running E2E tests against pre-built Docker images. ```bash export DOCKER_REGISTRY="ghcr.io/graphql-hive/" export DOCKER_TAG=":IMAGE_TAG_HERE" ``` -------------------------------- ### Fixed MiB Memory Limiter Configuration Source: https://github.com/graphql-hive/console/blob/main/docker/configs/otel-collector/benchmark.md Configure the memory limiter using a fixed MiB value. This configuration passed the benchmark but exhibited high CPU and memory usage. ```yaml memory_limiter: check_interval: 1s limit_mib: 1000 spike_limit_mib: 200 ``` -------------------------------- ### Show Hive CLI Information Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md This command displays information about the current token used by the Hive CLI. ```bash $ hive whoami ``` -------------------------------- ### Force Generate .env Files Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Forces the regeneration of .env files, ensuring that environment variables are correctly set up for the development environment. ```bash pnpm env:sync --force ``` -------------------------------- ### OIDC Mock Server Login Credentials Source: https://github.com/graphql-hive/console/blob/main/docs/DEVELOPMENT.md Use these credentials to log in to the mock OIDC server during local testing. ```dotenv # Username test-user # Password password ``` -------------------------------- ### Session Refresh Flow Diagram Source: https://github.com/graphql-hive/console/blob/main/packages/services/server/src/supertokens-at-home/README.md Illustrates the process of refreshing a user's session, including token verification, session validation, and new token generation. ```mermaid graph TD subgraph Session Refresh Flow A[POST /auth/session/refresh] --> B{Extract Refresh Token from Cookie}; B --> E{Verify Refresh Token Signature & Expiry}; E -- Invalid --> F[Clear Cookies & 401 Unauthorized]; E -- Valid --> G{Extract Session Handle from Token}; G --> H{Fetch Session from Store}; H -- Not Found --> F; H -- Found --> I(Validate Session); end subgraph Validate Session Sub-Flow I --> I1{Is Provided Refresh Token the LATEST one for this session?}; I1 -- No (Old token was used) --> I2[TOKEN THEFT DETECTED]; I2 --> I3[Revoke all sessions for this user & Clear Cookies]; I1 -- Yes --> J{Generate New Access Token}; end subgraph Token Generation and Response J --> K{"Generate New Refresh Token (Token Rotation)"}; K --> L{Update Session in Store with new token hash}; L --> M{Set New Tokens in Cookies}; M --> N[200 OK]; end ``` -------------------------------- ### Hive CLI `dev` Command Usage Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md This snippet outlines the available flags and arguments for the `hive dev` command. It details options for specifying service URLs, names, registry endpoints, access tokens, schema files, and composition modes (local or remote). ```bash USAGE $ hive dev (--url
... --service ...) [--debug] [--registry.endpoint --remote] [--registry ] [--registry.accessToken ] [--token ] [--schema ... ] [--watch] [--watchInterval ] [--write ] [--target ] FLAGS --debug Whether debug output for HTTP calls and similar should be enabled. --registry= registry address (deprecated in favor of --registry.endpoint) --registry.accessToken= registry access token --registry.endpoint= registry endpoint --remote Compose provided services remotely --schema=... Service sdl. If not provided, will be introspected from the service --service=... (required) Service name --target= The target to use for composition (slug or ID). This can either be a slug following the format "$organizationSlug/$projectSlug/$targetSlug" (e.g "the-guild/graphql-hive/staging") or an UUID (e.g. "a0f4c605-6541-4350-8cfe-b31f21a4bf80"). --token= api token (deprecated in favor of --registry.accessToken) --url=
... (required) Service url --watch Watch mode --watchInterval= [default: 1000] Watch interval in milliseconds --write= [default: supergraph.graphql] Where to save the supergraph schema file DESCRIPTION Develop and compose Supergraph with your local services. Only available for Federation projects. Two modes are available: 1. Local mode (default): Compose provided services locally. (Uses Hive's native Federation v2 composition) 2. Remote mode: Perform composition remotely (according to project settings) using all services registered in the registry. Work in Progress: Please note that this command is still under development and may undergo changes in future releases ``` -------------------------------- ### hive app:publish Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md Publishes an existing app deployment. Requires the app name and version, and optionally accepts target and registry details. ```APIDOC ## `hive app:publish` ### Description Publishes an existing app deployment. Requires the app name and version, and optionally accepts target and registry details. ### Method CLI Command ### Endpoint N/A (CLI Command) ### Parameters #### Flags - **--name** (string) - Required - App name. - **--version** (string) - Required - App version. - **--target** (string) - Optional - The target in which the app deployment will be published (slug or ID). This can either be a slug following the format "$organizationSlug/$projectSlug/$targetSlug" (e.g "the-guild/graphql-hive/staging") or an UUID (e.g. "a0f4c605-6541-4350-8cfe-b31f21a4bf80"). - **--debug** (boolean) - Optional - Whether debug output for HTTP calls and similar should be enabled. - **--registry.endpoint** (string) - Optional - Registry endpoint. - **--registry.accessToken** (string) - Optional - Registry access token. ### Request Example ```bash hive app:publish --name "my-app" --version "1.0.0" --target "my-org/my-project/staging" ``` ### Response #### Success Response - App deployment published successfully. #### Response Example (No specific response example provided in source) ``` -------------------------------- ### Fetch Schema, Supergraph, or Subgraphs using Hive CLI Source: https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md This command fetches schema definitions, supergraphs, or lists of subgraphs from the Hive API. You can specify a commit SHA or external ID, and use flags to control output, specify the type of data to fetch, and provide registry or target details. ```bash hive schema:fetch [COMMIT] [--debug] [--registry ] [--token ] [--registry.endpoint ] [--registry.accessToken ] [--type ] [--write ] [--outputFile ] [--target ] ```