https://github.com/pyjarrett/septum

Context-based code search tool
https://github.com/pyjarrett/septum

ada grep grep-like grep-search search-in-text septum text

Last synced: 15 days ago
JSON representation

Context-based code search tool

• Host: GitHub
• URL: https://github.com/pyjarrett/septum
• Owner: pyjarrett
• License: apache-2.0
• Created: 2021-04-26T01:50:20.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T05:47:16.000Z (8 months ago)
• Last Synced: 2024-07-31T17:15:22.216Z (3 months ago)
• Topics: ada, grep, grep-like, grep-search, search-in-text, septum, text
• Language: Ada
• Homepage:
• Size: 404 KB
• Stars: 371
• Watchers: 5
• Forks: 6
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-ada - septum - An interactive context-based text search tool for searching large codebases. (Tools / DevOps)

README

        
# septum

[![Alire](https://img.shields.io/endpoint?url=https://alire.ada.dev/badges/septum.json)](https://alire.ada.dev/crates/septum.html)

[![Build Status](https://github.com/pyjarrett/septum/actions/workflows/ada.yml/badge.svg)](https://github.com/pyjarrett/septum/actions)

[![Test Status](https://github.com/pyjarrett/septum/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/pyjarrett/septum/actions)

Context-based code search tool

# What does this do?

Septum is like `grep`, but searches for matching contexts of contiguous lines,

rather than just single lines.

![Include match](docs/images/context_match.png)

Limiting the search into blocks around search terms allows searching for elements

in arbitrary order which may span across lines, in a way which can be difficult

to express in other tools. Sometimes terms appear multiple times in a project and

have names which change based on context. Septum allows exclusion of these contexts.

![Exclude match](docs/images/excluded_match.png)

# Why does this exist?

Finding what you need in large codebases is hard.  Sometimes terms have multiple

meanings in different parts of the project, and figuring out what you're looking

for needs to be done in an incremental fashion.

Septum provides an interactive environment to push and pop search filters

to narrow or expand a search.

Septum is designed to be a standalone application for the lone developer on

their own hardware, searching closed source software. This means the program

should use a minimum number of dependencies to simplify security auditing and

perform no network operations.

![Command diagram](docs/images/command_overview.png)

# Example

[![asciicast](https://asciinema.org/a/459292.svg)](https://asciinema.org/a/459292)

# Building

1. This project requires a recent release of the [Alire](https://github.com/alire-project/alire/releases) tool to build.

2. Install a toolchain.

```bash

alr toolchain --select

```

3. Build

```bash

alr build

```

4. Executable should be at `bin/septum(.exe)`

# Installation

> Septum is currently available as a prerelease beta.

**Windows Chocolatey** users can it in the [Chocolatey Community Repository](https://community.chocolatey.org/packages/septum/):

```powershell

choco install septum --version=0.0.7

```

# Contributing

Septum aims to help every developers everywhere.  You're encouraged to recommend

features, report bugs, or submit pull requests.

# License

Septum is released under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0)