ghloc (GitHub Lines Of Code)

ghloc is a project for counting the number of non-empty lines of code in a project.

Note Try out web UI: ghloc.vercel.app (thanks @pajecawav, github: ghloc-web).

ghloc can work in 2 modes:

• As console utility for getting info about current directory.
• As server for getting info about any public Github repository.

CLI mode

Installation (it uses go tool):

go install github.com/subtle-byte/ghloc/cmd/ghloc@latest

And then to count lines of code in the current directory - run the command ghloc. The web page will be open with the results, e.g.:

Thanks @pajecawav for this web UI (https://github.com/pajecawav/ghloc-cli-ui).

You also can print results in the console using ghloc -c. Also if you want to count only some files you can use -m (stands for matcher), e.g. to consider only Markdown files use ghloc -m .md (see full matcher syntax below).

Server mode

The idea is simple: you make a request to the API in the format /<username>/<repository>/<branch> (or just /<username>/<repository> (the branch master or main will be used if any exists)) and you get the response with human-readable JSON.

It is deployed on the ghloc.ifels.dev (although no any guaranty), so it possible to get statistics using ghloc.ifels.dev/go-chi/chi for example.

You can see only some files using match URL parameter, e.g. with /someuser/somerepo?match=js only paths containing js will be considered. Examples of more powerful usage:

• match=.js$ will show only paths ending with .js.
• match=^src/ will show only paths starting with src/ (i.e. placed in the src folder).
• match=!test will filter out paths containing test.
• match=!test,!.sum will filter out paths containing test or .sum.
• match=.json$,!^package-lock.json$ will show only json files except for package-lock.json file.

There is also filter URL parameter, which has the opposite behavior to match parameter. filter has the same syntax but it declares which files must be filtered out.

To make the response more compact (removing spaces from the json) you can use pretty=false, e.g. /someuser/somerepo?pretty=false.