#@soda-gql/tools (CLI)

Command-line interface for soda-gql code generation. The CLI binary soda-gql is provided by the @soda-gql/tools package, which also includes codegen (@soda-gql/tools/codegen), typegen (@soda-gql/tools/typegen), and formatter (@soda-gql/tools/formatter).

#Installation

bun add -D @soda-gql/tools

#Commands

#codegen

Generate the type-safe GraphQL system from your schema:

bun run soda-gql codegen

#Options

#Subcommand: codegen graphql

Generate TypeScript compat code from existing .graphql operation files:

bun run soda-gql codegen graphql --input "src/**/*.graphql" --output src/generated

This is useful for:

• Migrating existing GraphQL operations to soda-gql
• Teams preferring to write operations in .graphql files
• Gradual adoption of the soda-gql type-safe API

Options:

Example:

Given src/queries/GetUser.graphql:

query GetUser($id: ID!) {
  user(id: $id) {
    id
    name
  }
}

Running:

bun run soda-gql codegen graphql --input "src/queries/*.graphql" --output src/generated

Generates src/generated/GetUser.compat.ts:

import { gql } from "../graphql-system";

export const GetUserCompat = gql.default(({ query }) =>
  query.compat("GetUser")`($id: ID!) {
    user(id: $id) {
      id
      name
    }
  }`(),
);

#builder

Generate runtime artifacts during development:

bun run soda-gql builder --mode runtime --entry ./src/**/*.ts --out ./.cache/soda-gql/runtime.json

#Configuration

Create a soda-gql.config.ts file:

import { defineConfig } from "@soda-gql/config";

export default defineConfig({
  outdir: "./src/graphql-system",
  include: ["./src/**/*.ts"],
  schemas: {
    default: {
      schema: "./schema.graphql",
      inject: "./src/graphql-system/default.inject.ts",
    },
  },
});

#See Also

• Getting Started - Setup instructions
• @soda-gql/config - Configuration options