Introducing Octohint

Read code at GitHub in an intelligent way

Rongjian Zhang
2 min readDec 13, 2017

GitHub is awesome. I read open source code at GitHub almost every day.

But there is a problem always bothering me. When I want to find references of a variable, or the definition position of a function, I have to use Cmd + f to find all occurrences, and check them one by one. That’s awful, especially when the file has a large number of lines.

The other approach is to git clone the whole repository to local, open it with a powerful editor like VSCode, then it is easier to find references and definition with its powerful intelligent hint.

So, is there an intelligent way to read code at GitHub?

The answer is YES. Octohint did it.

A picture is worth a thousand words

A TypeScript file at GitHub, with Octohint

Wow, no more cmd + f and git clone!

Installation

Octohint is a browser extension. If you use Chrome, just click here to download it from Chrome Web Store. Firefox, Opera and Safari users, see here.

You could click to show all references of current variable, and press cmd + click to go to definition of current variable.

Not only GitHub, GitLab and Bitbucket are also supported.

View README at GitHub for more details.

FAQ

Could it work at my private GitHub/GitLab/Bitbucket?

Yes. See here

Will it upload my private project’s code to your server?

No. All code analysis are performed at your browser. Feel free to use it!

Links

--

--