status: Status

Description Usage Arguments Value Examples

View source: R/status.R

Description

Display state of the repository working directory and the staging area.

Usage

1
2
3
4
5
6
7
8
status(
  repo = ".",
  staged = TRUE,
  unstaged = TRUE,
  untracked = TRUE,
  ignored = FALSE,
  all_untracked = FALSE
)

Arguments

repo

a path to a repository or a git_repository object. Default is '.'

staged

Include staged files. Default TRUE.

unstaged

Include unstaged files. Default TRUE.

untracked

Include untracked files and directories. Default TRUE.

ignored

Include ignored files. Default FALSE.

all_untracked

Shows individual files in untracked directories if untracked is TRUE.

Value

git_status with repository status

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
## Not run: 
## Initialize a repository
path <- tempfile(pattern="git2r-")
dir.create(path)
repo <- init(path)

## Config user
config(repo, user.name = "Alice", user.email = "alice@example.org")

## Create a file
writeLines("Hello world!", file.path(path, "test.txt"))

## Check status; untracked file
status(repo)

## Add file
add(repo, "test.txt")

## Check status; staged file
status(repo)

## Commit
commit(repo, "First commit message")

## Check status; clean
status(repo)

## Change the file
writeLines(c("Hello again!", "Here is a second line", "And a third"),
           file.path(path, "test.txt"))

## Check status; unstaged file
status(repo)

## Add file and commit
add(repo, "test.txt")
commit(repo, "Second commit message")

## Check status; clean
status(repo)

## End(Not run)

Example output

Untracked files:
	Untracked:  test.txt

Staged changes:
	New:        test.txt

[fd85a20] 2021-03-10: First commit message
working directory clean
Unstaged changes:
	Modified:   test.txt

[cce6962] 2021-03-10: Second commit message
working directory clean

git2r documentation built on Jan. 13, 2021, 8:40 a.m.

Related to status in git2r...