Skip to content

Commit ab28a9f

Browse files
committed
docs: add more info about auth
#46
1 parent 4fbc0cf commit ab28a9f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,12 @@ const { source, dir } = await downloadRepo("themes:test", {
203203
});
204204
```
205205

206+
## Providing token for private repositories
207+
208+
For private repositories and sources, you might need a token. In order to provide it, using CLI, you can use `--auth`, using programmatic API using `auth` option and in both modes also it is possible to use `GIGET_AUTH` environment variable to set it. The value will be set in `Authorization: Bearer ...` header by default.
209+
210+
**Note:** For github private repository access with Fine-grained access tokens, you need to give **Contents** and **Metadata** repository permissions.
211+
206212
## Related projects
207213

208214
Giget wouldn't be possible without inspiration from former projects. In comparison, giget does not depend on any local command which increases stability and performance and supports custom template providers, auth, and many more features out of the box.

0 commit comments

Comments
 (0)