Skip to content

Commit f9bfbff

Browse files
committed
Write documentation for the defaults for owner and repo
1 parent 139da9f commit f9bfbff

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,18 @@ Once you've installed **labels** and set up the environment variables, you're
2929
ready to use the **labels** CLI to manage issue labels for a GitHub
3030
repository. The CLI comes with two commands: ``fetch`` and ``sync``.
3131

32-
Both require you to specify the owner and the name of the GitHub repository
33-
using CLI options:
32+
Both commands require the owner and the name of the GitHub repository to
33+
fetch from or sync to. By default, **labels** tries to load this information
34+
from your local Git repository based on the URL for the `origin` remote
35+
repository.
36+
37+
For example, if you run **labels** from your local clone of the [earth
38+
][earth_repo] repository with `origin` set to
39+
`[email protected]:hackebrot/earth.git`, owner will be `hackebrot` and repo will
40+
be `earth`. 🌍
41+
42+
You can override each of these values manually using the following CLI
43+
options:
3444

3545
```text
3646
-o, --owner TEXT GitHub owner name
@@ -165,10 +175,11 @@ project you agree to abide by its terms.
165175
Distributed under the terms of the MIT license, **labels** is free and open
166176
source software.
167177

178+
[PyPI]: https://pypi.org/
168179
[code of conduct]: https://github.com/hackebrot/labels/blob/master/.github/CODE_OF_CONDUCT.md
169180
[contributing]: https://github.com/hackebrot/labels/blob/master/.github/CONTRIBUTING.md
170181
[create token]: https://blog.github.com/2013-05-16-personal-api-tokens/
182+
[earth_repo]: https://github.com/hackebrot/earth
171183
[first]: https://github.com/hackebrot/labels/labels/good%20first%20issue
172-
[toml]: https://github.com/toml-lang/toml
173-
[PyPI]: https://pypi.org/
174184
[pip]: https://pypi.org/project/pip/
185+
[toml]: https://github.com/toml-lang/toml

0 commit comments

Comments
 (0)