---
title: "overlane task policy"
description: "Show whether changes need an active task, and refresh this working copy's copy"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane task policy

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Reads the project's task requirement (default `required`: edits and mutating shell commands are refused without an active task) and writes it to .overlane/state/task-policy.json for the hooks.

## Usage

```sh
overlane task policy
```

## Examples

```sh
overlane task policy
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema task policy`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "enforcement": {
      "type": "string",
      "enum": [
        "required",
        "relaxed"
      ]
    },
    "reason": {
      "type": "string"
    },
    "changedBy": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "localFile": {
      "type": "string"
    }
  },
  "required": [
    "enforcement",
    "localFile"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/task-policy/index.mdx