File: git_sitrep.Rd

package info (click to toggle)
r-cran-usethis 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: sh: 26; makefile: 17; cpp: 6; ansic: 3
file content (28 lines) | stat: -rw-r--r-- 721 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/git.R
\name{git_sitrep}
\alias{git_sitrep}
\title{Git/GitHub sitrep}
\usage{
git_sitrep(tool = c("git", "github"), scope = c("user", "project"))
}
\arguments{
\item{tool}{Report for \strong{git}, or \strong{github}}

\item{scope}{Report globally for the current \strong{user}, or locally for the
current \strong{project}}
}
\description{
Get a situation report on your current Git/GitHub status. Useful for
diagnosing problems. The default is to report all values; provide values
for \code{tool} or \code{scope} to be more specific.
}
\examples{
\dontrun{
# report all
git_sitrep()

# report git for current user
git_sitrep("git", "user")
}
}