projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-06-28 23:01:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add FAQ for resolving github api token issues

Browse source
This commit is contained in:
Ian Ferguson 2016-06-10 08:47:24 -04:00
parent d57bee59ce
commit abddf33f46
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -162,3 +162,25 @@ A plugin is:
### How can I list plugins as dependencies to my plugin?
Create a new fishfile at the root level of your project and write the plugin URL such as *github.com/owner/repo*.
### Why am I receiving errors when running `fisher ls-remote`?
If you are consistently seeing the following error while repeatedly running `fisher ls-remote`:
```
! I could not update the remote index.
This is most likely a problem with http://api.github.com/
or a connection timeout. If the problem persists, open an
issue in: <github.com/fisherman/fisherman/issues>
```
You may need to set the GITHUB_USER and GITHUB_TOKEN environment variables in your shell, to prevent github's search api from
throttling/rejecting anonymous requests:
```
set -x GITHUB_USER your_username
set -x GITHUB_TOKEN your_github_api_token_for_fisherman
```
For instructions on creating an api token, [see Step 1 of this help guide from Christopher Anderson](https://gist.github.com/christopheranderton/8644743#step-1---create-a-personal-access-token-for-homebrew)