Git Product home page Git Product logo

ghfs's Introduction

ghfs godoc Version

The GitHub Filesystem (GHFS) is a user space filesystem that overlays the GitHub API. It allows you to access repositories and files using standard Unix commands such as ls and cat.

Install

To use ghfs, you'll need to install Go. If you're running OS X then you'll also need to install MacFUSE. Then you can install ghfs by running:

$ go get github.com/benbjohnson/ghfs/...

This will install ghfs into your $GOBIN directory. Next you'll need to create a directory and use ghfs to mount GitHub:

$ mkdir ~/github
$ ghfs ~/github &

Now you can read data from the GitHub API via the ~/github directory.

Usage

GHFS uses GitHub URL conventions for pathing. For example, to go to a user you can cd using their username:

$ cd ~/github/boltdb

To go to a repository, you can use the username and repository name:

$ cd ~/github/boltdb/bolt

Once you're in a repository, you can list files using ls and you can print out file contents using the cat tool.

bolt $ cat LICENSE
The MIT License (MIT)

Copyright (c) 2013 Ben Johnson

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
...

ghfs's People

Contributors

benbjohnson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

bradparks orivej

ghfs's Issues

Branches

Add support for browsing branches.

Caching

Add a caching layer to the *github.Client.

Commits

Add support for listing commits.

Organizations

Add support for browsing organizations and users in an org.

Releases

Add support for browsing releases.

Search

Add support for searching. Not exactly sure how this will work.

Issues

Add support for browsing issues.

cannot use Root literal

I'm totally new to go and installing things with go, but when I tried to install using

$ go get github.com/benbjohnson/ghfs/...

I get the following error:

$ go get github.com/benbjohnson/ghfs/...                                                                                                                                                               # github.com/benbjohnson/ghfs/cmd/ghfs
/Users/bparks/go/src/github.com/benbjohnson/ghfs/cmd/ghfs/main.go:62: cannot use Root literal (type *Root) as type fs.Node in return argument:
        *Root does not implement fs.Node (wrong type for Attr method)
                have Attr() fuse.Attr
                want Attr(*fuse.Attr)
/Users/bparks/go/src/github.com/benbjohnson/ghfs/cmd/ghfs/main.go:82: cannot use User literal (type *User) as type fs.Node in return argument:
        *User does not implement fs.Node (wrong type for Attr method)

I'm on a mac (10.8.5) and using zsh if it matters.... thanks!

Pathing

Update paths to match Github so that commits, branches and tags can be browsed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.