Start here. Prints what an agent needs to orient itself in one call: whether you are signed in, the project binding, the installed and pinned release, the active task and run, the run policy and budgets, the next runnable task, and the three most useful commands to run next. Local fields never need the network. Service fields are asked with a 1.5 second deadline and read “unreachable” (or “unauthenticated”) when they could not be reached, so it works fully offline.
Usage
overlane contextExamples
overlane context
overlane context --textBehavior
- Effect:
read(changes nothing). - Needs credentials: no. Uses the network: yes.
- Supports
--dry-run: no. Accepts--force: no. - Machine-readable description:
overlane schema context.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"type": "object",
"properties": {
"tool": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "overlane"
},
"version": {
"type": "string"
},
"docs": {
"type": "string"
}
},
"required": [
"name",
"version",
"docs"
],
"additionalProperties": false
},
"auth": {
"type": "object",
"properties": {
"signedIn": {
"type": "boolean"
},
"how": {
"type": "string",
"enum": [
"keychain",
"file",
"none"
]
},
"expired": {
"type": "boolean"
}
},
"required": [
"signedIn",
"how"
],
"additionalProperties": false
},
"project": {
"anyOf": [
{
"type": "object",
"properties": {
"bound": {
"type": "boolean",
"const": true
},
"root": {
"type": "string"
},
"projectId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"service": {
"type": "string"
},
"serviceStatus": {
"anyOf": [
{
"type": "string",
"const": "reachable"
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
}
},
"required": [
"bound",
"root",
"projectId",
"tenantId",
"service",
"serviceStatus"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"bound": {
"type": "boolean",
"const": false
},
"root": {
"type": [
"string",
"null"
]
},
"reason": {
"type": "string",
"enum": [
"not a git repository",
"not connected",
"binding invalid"
]
},
"service": {
"type": "string"
}
},
"required": [
"bound",
"root",
"reason",
"service"
],
"additionalProperties": false
}
]
},
"release": {
"type": "object",
"properties": {
"installed": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"type": "string"
},
"digest": {
"type": "string"
}
},
"required": [
"version",
"digest"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pinned": {
"type": [
"string",
"null"
]
},
"pinnedByService": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
},
"inSync": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"const": "unknown"
}
]
}
},
"required": [
"installed",
"pinned",
"pinnedByService",
"inSync"
],
"additionalProperties": false
},
"task": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"taskId": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
},
"holder": {
"type": "string"
}
},
"required": [
"active"
],
"additionalProperties": false
},
"run": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"runId": {
"type": "string"
},
"executor": {
"type": "string"
},
"tasksClaimed": {
"type": "number"
},
"minutesUsed": {
"type": "number"
},
"stop": {
"type": "string"
}
},
"required": [
"active"
],
"additionalProperties": false
},
"policy": {
"type": "object",
"properties": {
"status": {
"anyOf": [
{
"type": "string",
"enum": [
"active",
"paused"
]
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
},
"budgets": {
"anyOf": [
{
"type": "object",
"properties": {
"maxTasksPerRun": {
"type": "number"
},
"maxMinutesPerRun": {
"type": "number"
},
"usagePolicy": {
"type": "object",
"properties": {
"order": {
"default": "sequential",
"type": "string",
"enum": [
"sequential",
"round_robin",
"parallel"
]
},
"maxParallel": {
"default": 1,
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"pace": {
"default": "asap",
"type": "string",
"enum": [
"asap",
"steady"
]
},
"capPercent": {
"default": 85,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"reservePercent": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 99
},
"iterationsPerWindow": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"order",
"maxParallel",
"pace",
"capPercent",
"reservePercent"
],
"additionalProperties": false
},
"executorsAllowed": {
"type": "array",
"items": {
"type": "string"
}
},
"handoffOnLimit": {
"anyOf": [
{
"type": "string",
"const": "pause"
},
{
"minItems": 1,
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"claude-code",
"codex",
"gemini-cli",
"cursor"
]
},
{}
]
}
}
]
},
"buildAheadLimit": {
"type": "string"
}
},
"required": [
"maxTasksPerRun",
"maxMinutesPerRun",
"usagePolicy",
"executorsAllowed",
"handoffOnLimit",
"buildAheadLimit"
],
"additionalProperties": false
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
},
"source": {
"type": "string",
"enum": [
"service",
"run snapshot",
"none"
]
}
},
"required": [
"status",
"budgets",
"source"
],
"additionalProperties": false
},
"onboarding": {
"anyOf": [
{
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"step": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"complete",
"step"
],
"additionalProperties": false
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
},
{
"type": "string",
"const": "not applicable"
}
]
},
"next": {
"anyOf": [
{
"type": "object",
"properties": {
"taskId": {
"type": "string"
},
"title": {
"type": "string"
},
"milestone": {
"type": "string"
}
},
"required": [
"taskId",
"title",
"milestone"
],
"additionalProperties": false
},
{
"type": "null"
},
{
"anyOf": [
{
"type": "string",
"const": "unreachable"
},
{
"type": "string",
"const": "unauthenticated"
}
]
}
]
},
"suggested": {
"type": "array",
"items": {
"type": "string"
}
},
"causes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"http",
"timeout",
"network",
"unexpected_answer"
]
},
"status": {
"type": "number"
},
"code": {
"type": "string"
}
},
"required": [
"kind"
],
"additionalProperties": false
}
}
},
"required": [
"tool",
"auth",
"project",
"release",
"task",
"run",
"policy",
"onboarding",
"next",
"suggested"
],
"additionalProperties": false
}See exit codes for the status the process returns.