[go: up one dir, main page]

Skip to content

Source code query command line interface

License

Notifications You must be signed in to change notification settings

BFergerson/GitSocratic

Repository files navigation

GitSocratic

Source code query command line interface

Build Status

gitsocratic architecture

GitSocratic provides a pain-free interface for querying source code. GitSocratic uses the omnilingual parser Babelfish to extract universal abstract syntax trees (which are additionally annotated with their semantic meanings) and imports that data into a knowledge graph powered by Grakn. This process is fully facilitated by GitSocratic's integration with Phenomena.

Features

Setup

GitSocratic requires access to two services:

GitSocratic is able to install these services automatically using Docker. If you do no wish to use Docker you may supply the host and ports for these services through the config file or command.

To automatically setup these services with Docker, simply use the command:

gitsocratic init

Note: This command may take several minutes on the first use.

Bare-bones installation

apt-get update
apt install openjdk-8-jre-headless
apt install unzip
apt install docker.io
wget https://github.com/CodeBrig/GitSocratic/releases/download/v0.2.1-alpha/gitsocratic-0.2.1.zip
unzip gitsocratic-0.2.1.zip
cd gitsocratic-0.2.1/bin/
./gitsocratic init

Usage

gitsocratic [-hV] [-c=<configFile>] [COMMAND]

asciicast

Commands

add-local-repo   Add local source code repository to the knowledge graph
add-remote-repo  Add remote source code repository to the knowledge graph
config           Configure GitSocratic
console          Open interactive source code query console
init             Initialize services necessary to use GitSocratic
logs             View logs for initialized services
query            Execute a single source code query
question         Execute a single source code question

More information: COMMANDS

License

Apache 2.0