You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-6Lines changed: 22 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,26 @@
5
5
6
6
A CLI and Go library for GitHub's [CODEOWNERS file](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax).
7
7
8
-
## Installation
8
+
## Command line tool
9
9
10
-
Install the CLI from the [homebrew tap](https://github.com/hmarr/homebrew-tap#codeowners).
10
+
The `codeowners` CLI identifies the owners for files in a local repository or directory.e
11
+
12
+
### Installation
13
+
14
+
If you're on macOS, you can install the CLI from the [homebrew tap](https://github.com/hmarr/homebrew-tap#codeowners).
11
15
12
16
```console
13
17
$ brew tap hmarr/tap
14
18
$ brew install codeowners
15
19
```
16
20
17
-
Install the library with `go install`.
21
+
Otherwise, grab a binary from the [releases page](https://github.com/hmarr/codeowners/releases) or install from source with `go install`:
18
22
19
23
```console
20
24
$ go install github.com/hmarr/codeowners/cmd/codeowners@latest
21
25
```
22
26
23
-
##Command line usage
27
+
### Usage
24
28
25
29
By default, the command line tool will walk the directory tree, printing the code owners of any files that are found.
26
30
@@ -71,9 +75,21 @@ $ codeowners -u
71
75
CODEOWNERS (unowned)
72
76
```
73
77
74
-
## Go library usage
78
+
## Go library
79
+
80
+
A package for parsing CODEOWNERS files and matching files to owners.
81
+
82
+
### Installation
83
+
84
+
```console
85
+
$ go get github.com/hmarr/codeowners
86
+
```
87
+
88
+
### Usage
89
+
90
+
Full documentation is available at [pkg.go.dev](https://pkg.go.dev/github.com/hmarr/codeowners).
75
91
76
-
Documentation is available at [pkg.go.dev](https://pkg.go.dev/github.com/hmarr/codeowners).
0 commit comments