insight-cli 0.0.1

No project description provided

insight-cli

Overview

insight is a search engine that enables developers to semantically search Python codebases using natural language queries. The insight-cli provides a CLI for developers to use insight.

Installation

Before installing the insight-cli, ensure that Python version 3.10.0+ is installed. To install the insight-cli globally, run the following command:

$ pip install insight-cli

To ensure the insight-cli was successfully installed, check the insight-cli version by running the following command:

$ insight --version

CLI Commands

The following cli commands require an internet connection.

To initialize the current directory as an insight repository, run the following command:

$ insight --initialize

The following commands must be ran in a directory that has been initialized as an insight repository.

To display the Python files (.py files) and lines in an insight repository (excluding the files and directories specified in the .insightignore file) that semantically match a given natural language query, run the following command:

$ insight --query "<query>"

To uninitialize an insight repository, run the following command:

$ insight --uninitialize

.insightignore

The .insightignore file contains regex patterns that specify directory and file paths to ignore in an insight repository.

• Each line will be considered as a single regex pattern.
• Empty lines are not matchable, they serve only as separators for readability.
• Lines starting with a hashtag '#' serve as comments. A single backslash '\' is placed in front of the first hashtag for patterns that begin with a literal hashtag.
• Scope comments designate patterns to apply exclusively within a specified scope until encountering another scope comment. '## _directory_' and '## _file_' are scope comments which designate patterns to apply within directory and file path scopes respectively.

# Ignore all directory and file paths ending in "test.py"
.*test\.py$

# Ignore all directory and file paths starting with "test_"
^test_

# Ignore all directory and file paths that are exactly "#.py"
\#\.py$

## _directory_
# Patterns now only apply to directory paths

# Ignore all directory paths starting with "main"
^main

## _file_
# Patterns now only apply to file paths

# Ignore all file paths starting with "cache"
^cache

Example Usage

Install the insight-cli.

$ pip install insight-cli

Change the current working directory to the desired codebase. This example will use the following GitHub repository: https://github.com/ChenGrant/instapix-word2vec.

$ git https://github.com/ChenGrant/instapix-word2vec
$ cd instapix-word2vec

Initialize the current directory as an insight repository. This will create a .insight directory inside the current directory.

$ insight --initialize
Initialized insight repository in /path/to/current/directory/instapix-word2vec

Create a .insightignore file in the current directory and specify that insight should ignore the proto directory.

$ echo "## _directory_ \n ^proto$" > .insightignore

Search in the current insight repository (excluding the proto directory) for the "function that loads the word2vec model".

$ insight --query "function that loads the word2vec model"
2 matches found in the following files:
/src/word2vec_service.py
    Line 13 - 21: def load_model(): ... return model;

/src/word2vec_service.py
    Line 26: self.model = load_model();

Contributing

Interested in contributing? Please read the Contribution Guidelines to get started.

License

This project is licensed under the MIT License.