Quickstart

Installation

You can install Code-PathFinder using pre-built binaries from GitHub releases or from source. More installation support via homebrew, curl will be added soon.

Using Docker 🐳

$ docker pull shivasurya/code-pathfinder:stable-latest

Using npm

Ensure you have Node.js installed. Then run the following command:

$ npm install -g codepathfinder
$ pathfinder --help

Pre-Built Binaries

Download the latest release from GitHub releases and choose the binary that matches your operating system.

$ chmod u+x pathfinder
$ pathfinder --help

From Source

Ensure you have Gradle and GoLang installed.

$ git clone https://github.com/shivasurya/code-pathfinder
$ cd sourcecode-parser
$ gradle buildGo
$ build/go/pathfinder --help

Sanity Check

Check if Code-PathFinder is working properly by running the following command:

$ pathfinder --version
Version: 0.0.23
Git Commit: 40886e7

$ pathfinder --help
Usage of pathfinder:
  -output string
        Supported output format: json
  -output-file string
        Output file path
  -project string
        Project to analyze
  -query string
        Query to execute
  -stdin
        Read query from stdin
  -version
        Print the version information and exit