Function branch

branch(): Promise<string>

List, create, rename, copy, or delete branches.

Returns Promise<string>

Example

// List local branches
await git.branch()

// List all branches
await git.branch({ flags: ["--all"] })

// Create a new branch
await git.branch("feature/login")

// Delete a branch
await git.branch("feature/login", { flags: ["--delete"] })

// Rename a branch
await git.branch(["old-name", "new-name"], { flags: ["--move"] })

Since

1.0.0

branch(opts: BranchOptions): Promise<string>

List, create, rename, copy, or delete branches.

Parameters

opts: BranchOptions

Returns Promise<string>

Example

// List local branches
await git.branch()

// List all branches
await git.branch({ flags: ["--all"] })

// Create a new branch
await git.branch("feature/login")

// Delete a branch
await git.branch("feature/login", { flags: ["--delete"] })

// Rename a branch
await git.branch(["old-name", "new-name"], { flags: ["--move"] })

Since

1.0.0

branch(name: string, opts?: BranchOptions): Promise<string>

List, create, rename, copy, or delete branches.

Parameters

name: string
Optionalopts: BranchOptions

Returns Promise<string>

Example

// List local branches
await git.branch()

// List all branches
await git.branch({ flags: ["--all"] })

// Create a new branch
await git.branch("feature/login")

// Delete a branch
await git.branch("feature/login", { flags: ["--delete"] })

// Rename a branch
await git.branch(["old-name", "new-name"], { flags: ["--move"] })

Since

1.0.0

branch(names: [string, string], opts?: BranchOptions): Promise<string>

List, create, rename, copy, or delete branches.

Parameters

names: [string, string]
Optionalopts: BranchOptions

Returns Promise<string>

Example

// List local branches
await git.branch()

// List all branches
await git.branch({ flags: ["--all"] })

// Create a new branch
await git.branch("feature/login")

// Delete a branch
await git.branch("feature/login", { flags: ["--delete"] })

// Rename a branch
await git.branch(["old-name", "new-name"], { flags: ["--move"] })

Since

1.0.0

Function branch

Returns Promise<string>

Example

Since

Parameters

Returns Promise<string>

Example

Since

Parameters

Returns Promise<string>

Example

Since

Parameters

Returns Promise<string>

Example

Since

Settings