[git.checkout]

git.checkout is a slot in the git namespace, in Hyperlambda, the language of Magic Cloud. Checks out a Git branch.

  • Value (git-repo-path), required: Repository path
  • Returns: Resolves to the git checkout command output

Arguments

Required arguments come first, then the optional ones in the order they are declared.

Argument Type Required Description
[branch] string yes Branch to check out.
[create] bool no Create the branch while checking it out. Default: false.

Guide: How to use [git.checkout]

JSON declaration

This is the complete declaration of git.checkout, as the running system describes it. It is also published as slot.json.

JSON declaration
{
  "name": "git.checkout",
  "description": "Checks out a Git branch",
  "signature": {
    "input": {
      "kind": "git-repo-path",
      "description": "Repository path",
      "required": true,
      "mode": "ValueOrExpression"
    },
    "children": {
      "branch": {
        "type": "string",
        "kind": "git-branch",
        "description": "Branch to check out",
        "required": true,
        "mode": "ValueOrExpression",
        "cardinality": "ExactlyOne",
        "role": "Option",
        "projection": "Value"
      },
      "create": {
        "type": "bool",
        "description": "Create the branch while checking it out",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "false",
        "role": "Option",
        "projection": "Value"
      }
    },
    "output": {
      "mode": "Value",
      "kind": "git-response,text",
      "description": "Resolves to the git checkout command output"
    }
  }
}

← git.branch.list all git.* slots git.clone-repo →