Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.52 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.52 KB

STEVE: Search Technical Evidence Very Easy

STEVE is a command-line tool specifically designed to help teams quickly verify that major architectural decisions are well-documented. It provides three main functionalities:

  • Search: Looks up documentation related to a query within a directory specified in your local .env file.
  • Audit: Uses git diff to compare the current changes and checks that important architectural decisions have been documented.
  • Roast: Also leverages git diff but provides a lighthearted code review.

Prerequisites

Installation

Install the project with Cargo:

cargo install steve

Configure your environment: Create a .env file (or copy an existing example) in the project you are working on and set the directory where your documentation resides:

OPENAI_API_KEY=<API_TOKEN>
STEVE_DOCS_PATH=/workspaces/Steve/docs

Usage

Run STEVE using one of its subcommands:

Search

Search in the documentation directory for evidence matching your query. If no query is given, STEVE reads from STDIN.

steve search "your query here"

Audit

Analyze the current changes to ensure that major architectural decisions are properly documented.

steve audit

Roast

Enjoy a fun, no-holds-barred code review by comparing current changes with documentation.

steve roast

License

This project is licensed under the MIT License.