overlane brief | Overlane Docs

git: “branch sha7 ahead N behind N of upstream, N dirty, last: subject” in one line, in place of git status and git log. tasks: the unticked “- [ ] P0” lines of TASKS.md cut to 160 characters (a repository without TASKS.md points at overlane task status). all (the default) prints both. Works offline.

Usage

overlane brief [what]

Arguments

Argument	Required	Description
`what`	no	git, tasks or all (default all)

Examples

overlane brief
overlane brief git
overlane brief tasks

Behavior

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

Result

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

{
  "type": "object",
  "properties": {
    "git": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "branch": {
              "type": "string"
            },
            "sha": {
              "type": "string"
            },
            "upstream": {
              "type": [
                "string",
                "null"
              ]
            },
            "ahead": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            "behind": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            "dirty": {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            "subject": {
              "type": "string"
            }
          },
          "required": [
            "branch",
            "sha",
            "upstream",
            "ahead",
            "behind",
            "dirty",
            "subject"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "tasks": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "TASKS.md",
            "none"
          ]
        },
        "open": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "more": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "source",
        "open",
        "more"
      ],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

See exit codes for the status the process returns.