Skip to content

Configuration

TekMemo uses a predictable configuration hierarchy. For any given setting, the resolution order is:

  1. CLI Flag (e.g., --cloud-url)
  2. Environment Variable (e.g., TEKMEMO_CLOUD_URL)
  3. Config File (e.g., .tekmemo/config.json)
  4. Built-in Default

Environment variables

VariablePurposeDefault
TEKMEMO_ROOTProject root folder containing .tekmemo/. (current directory)
TEKMEMO_RUNTIMERuntime mode: local, cloud, or hybridlocal
TEKMEMO_CLOUD_URLCloud API base URL ending in /api/v1
TEKMEMO_API_URLAlias for TEKMEMO_CLOUD_URL
TEKMEMO_API_KEYTekMemo Cloud API key
TEKMEMO_PROJECT_IDDefault Cloud project ID
TEKMEMO_WORKSPACE_IDOptional workspace context ID
TEKMEMO_CLOUD_TIMEOUT_MSCloud request timeout in milliseconds
TEKMEMO_READ_POLICYHybrid read policy (local-first, cloud-only, etc.)local-first
TEKMEMO_WRITE_POLICYHybrid write policy (local-first, cloud-only, etc.)local-first

Configuration file

The .tekmemo/config.json file stores project-specific defaults so you don't need to specify flags on every command.

Generate one using the CLI:

bash
npx tekmemo config init --runtime hybrid

Schema

json
{
  "version": 1,
  "runtime": "hybrid",
  "root": ".",
  "cloud": {
    "baseUrl": "https://memo.tekbreed.com/api/v1",
    "projectId": "proj_123",
    "workspaceId": "ws_456",
    "timeoutMs": 10000
  },
  "hybrid": {
    "readPolicy": "local-first",
    "writePolicy": "local-first"
  }
}

Properties

FieldDescription
runtime"local", "cloud", or "hybrid"
rootRelative path to the folder where memory operations should run
cloud.baseUrlTekMemo Cloud URL
cloud.projectIdDefault project ID
cloud.workspaceIdDefault workspace ID
cloud.timeoutMsTimeout in milliseconds (must be a positive integer)
hybrid.readPolicy"local-first", "cloud-first", "local-only", or "cloud-only"
hybrid.writePolicy"local-first", "cloud-first", "local-only", or "cloud-only"

Released under the MIT License.