Universal strait.json config file shared by all SDKs and the CLI.

Strait uses a universal strait.json configuration file that all five SDKs and the CLI can read. This replaces the TypeScript-specific strait.config.ts file (now deprecated).

Getting Started

Run the init command to create a strait.json file:

strait init

Or create one manually:

{
  "$schema": "https://strait.dev/schema.json",
  "project": {
    "id": "proj_abc123",
    "name": "My Project"
  },
  "sdk": {
    "base_url": "https://api.strait.dev",
    "auth_type": "apiKey",
    "timeout_ms": 30000
  },
  "src": "src",
  "runtime": "node",
  "build": {
    "out_dir": ".strait"
  },
  "deploy": {
    "default_environment": "production"
  }
}

Field Reference

project (required)

sdk (optional)

SDK client configuration. These values are read by all five SDKs.

CLI fields (optional)

These fields are read by the CLI only. SDKs ignore them.

Environment Variable Overrides

Environment variables always take precedence over strait.json values. This lets you use the config file for defaults while overriding per-environment in CI/CD or production.

Config File Discovery

All SDKs and the CLI look for strait.json in the current working directory. There is no upward directory traversal — the file must be at the project root where commands are invoked.

SDK discovery order

1. Explicit path (if provided via options)
2. strait.json in working directory
3. strait.config.ts / .js / .mjs / .cjs (deprecated, TypeScript SDK only)

CLI discovery order

1. Explicit --config flag
2. strait.json in working directory
3. strait.config.ts / .js / .mjs / .cjs (deprecated)

CLI connection resolution priority

When the CLI resolves server URL, project ID, and API key, the priority chain is:

CLI flags  >  env vars  >  CLI profile context  >  strait.json

Loading Config from Each SDK

import { createClientFromConfigFile } from "@strait/ts/node";

// Auto-discovers strait.json in cwd
const client = await createClientFromConfigFile();

// Or specify a directory
const client = await createClientFromConfigFile({ cwd: "/path/to/project" });

// Or an explicit path
const client = await createClientFromConfigFile({ configPath: "./config/strait.json" });

from strait import Client, AsyncClient

# Auto-discovers strait.json in cwd
client = Client.from_file()

# Or specify a directory
client = Client.from_file(search_dir="/path/to/project")

# Or an explicit path
client = Client.from_file(path="/path/to/custom-config.json")

# Async variant
async_client = AsyncClient.from_file()

import strait "github.com/strait-dev/go-sdk"

// Auto-discovers strait.json in cwd
client, err := strait.NewClientFromFile(nil)

// Or specify a directory
client, err := strait.NewClientFromFile([]strait.ConfigFileOption{
  strait.WithConfigDir("/path/to/project"),
})

// Or an explicit path
client, err := strait.NewClientFromFile([]strait.ConfigFileOption{
  strait.WithConfigPath("/path/to/custom-config.json"),
})

require "strait"

# Auto-discovers strait.json in cwd
client = Strait::Client.from_file

# Or specify a directory
client = Strait::Client.from_file(search_dir: "/path/to/project")

# Or an explicit path
client = Strait::Client.from_file(path: "/path/to/custom-config.json")

use strait_sdk::client::StraitClient;

// Auto-discovers strait.json in cwd
let client = StraitClient::from_file(None, None)?;

// Or specify a directory
let client = StraitClient::from_file(None, Some("/path/to/project"))?;

// Or an explicit path
let client = StraitClient::from_file(Some("/path/to/config.json"), None)?;

Migrating from strait.config.ts

If you're using the deprecated strait.config.ts, run:

strait init

This creates a strait.json file. You can then delete your strait.config.ts. The SDKs and CLI will automatically prefer strait.json when both files exist.

When a .ts config file is loaded, the SDK and CLI emit a deprecation warning:

strait.config.ts is deprecated. Run 'strait init' to migrate to strait.json.

strait init Command

The strait init command scaffolds a new strait.json interactively:

strait init

It prompts for:

1. Project ID
2. Project name (optional)
3. Source directory (default: src)
4. Runtime — Node.js or Bun (default: Node.js)
5. Base URL (optional)

It also checks your .gitignore and offers to add .strait (the build output directory).

Non-interactive mode

For CI/CD or scripting, use --yes with --project:

strait init --yes --project proj_abc123

This uses all defaults without prompting.