← All procedures

git.stash.push

Push changes to stash

CLI
Package
@procedures/git · README
Path
["git","stash","push"]
CLI
mark git stash push
As data
{"$proc":["git","stash","push"],"input":{}}

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/git"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["git","stash","push"], {});
console.log(JSON.stringify(result));

From the command line

$ mark git stash push

As data, in a program

{ "$proc": ["git", "stash", "push"], "input": {} }

Input

FieldTypeRequiredDefaultDescription
messagestringnoStash message
includeUntrackedbooleannoInclude untracked files (default: false)
keepIndexbooleannoKeep staged changes in index (default: false)
pathsstring[]noSpecific paths to stash
cwdstringnoWorking directory

Output

FieldTypeRequiredDefaultDescription
stashedbooleanyesTrue when the call stashed changes
refstringnoThe new stash reference
messagestringnoThe stash message
JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "message": {
        "description": "Stash message",
        "type": "string"
      },
      "includeUntracked": {
        "description": "Include untracked files (default: false)",
        "type": "boolean"
      },
      "keepIndex": {
        "description": "Keep staged changes in index (default: false)",
        "type": "boolean"
      },
      "paths": {
        "description": "Specific paths to stash",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "cwd": {
        "description": "Working directory",
        "type": "string"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "stashed": {
        "type": "boolean",
        "description": "True when the call stashed changes"
      },
      "ref": {
        "description": "The new stash reference",
        "type": "string"
      },
      "message": {
        "description": "The stash message",
        "type": "string"
      }
    },
    "required": [
      "stashed"
    ],
    "additionalProperties": {}
  }
}