Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): update usage #16

Merged
merged 1 commit into from
Apr 18, 2020
Merged

chore(readme): update usage #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ concept of FUSE.

## How to Use

Assuming that `ghafs` executable has already been built, the run command looks
like this:
Assuming that `ghafs` executable has already been built, the actual usage help
looks like this:

```bash
./ghafs <mountpoint> <repo_owner> <repo_name>
ghafs [--token TOKEN] [--allow-other] MOUNTPOINT OWNER REPO
```

Note that you should not need `root` privileges for the above command as long as
Expand All @@ -26,7 +26,13 @@ mkdir -p /tmp/tera-cli
./ghafs /tmp/tera-cli guangie88 tera-cli
```

You should then be able to traverse into `/tmp/tera-cli` to look at the various
Note that you should try to provide the GitHub access token so that you have a
much higher rate limit for GitHub API even for public repos. Also if you wish
for another user (e.g. `root`) to see the mounted directory, you will need to
specify the `--allow-other` flag.

Assuming you have successfully mounted after following the above given command,
you should then be able to traverse into `/tmp/tera-cli` to look at the various
release tags and assets with another terminal / file browser.

To unmount, currently one has to do the following:
Expand Down