Skip to content

Repository files navigation

quest-cli

Quest is a command-line tool for storing and structuring knowledge. You use markdown files to explain a certain idea or practice. These files are related to each other through a directed acyclic graph. This tool helps you manipulate, verify, and package this structured material into a single file format.

These files can be distributed and unpacked in markdown editors like Obsidian. Integration with this tool in your workflow is made easy through is simple yet comprehensive command-line interface.

Why Quest?

Quest facilitates the distribution and management of knowledge.

You can use the file format on education platforms for curriculum building and learning path creation (walks on the graph).

Being able to structure information using a standard format is important. Quest helps decrease uncertainty in the learning process by proposing and helping to enforce a structural standard for markdown content. Quest enforces this standard format using qst validate, which checks knowledge graph files for any formatting or structural violations (like cycles).

By offloading validation of content to a concrete system, you can focus on comprehending and building upon learning material.

Installation & Getting Started

Using go install

go install github.com/Carter907/quest-cli@latest

Install locally using go build:

git clone https://github.com/Carter907/quest-cli.git
cd quest-cli
go build -o $(go env GOPATH)/bin/qst .

Running qst:

qst --help

Usage

For a basic usage example of the commend, please read usage.md

Concepts

Check out concepts.md for more theoretical foundations.

Format

Find formatting constraints and metadata specifics in format.md

CLI Docs

Visit the cli docs for generated docs on the command-line interface (qst functionality).

About

A tool for verification, packing, and distribution of knowledge graphs.

Topics

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages