prompto

KO | EN

gitlite — search

#javascript #react #llm #go #deep-learning #docker #nodejs #macos #java #windows #awesome #kubernetes #mcp #ios

(★ 14)

Quickly get custom prompt contexts

prompto Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PROMPTO

## Overview

`prompto` is a command-line tool designed to generate context for prompting Large Language
Models (LLMs). It bridges the gap between the limited context size of LLMs and the
necessity for substantial API and documentation during code generation.

To see an example of a repository's `prompto` directory, check out [common-sense](https://github.com/go-go-golems/common-sense/tree/main/prompto/cms).

![image](https://github.com/go-go-golems/prompto/assets/128441/f1549479-e9e5-47a9-9f1e-8832b93fa8ae)

## Why did I write `prompto`?

Prompting LLMs with an exhaustive context derived from API and other technical documents aids in generating precise
code. Manually copying and pasting the appropriate context from source files can be laborious. Though tools
like [oak](https://github.com/go-go-golems/oak) facilitate by using tree-sitter queries on codebases, there's often a need to run
diverse sets of queries on distinct parts of the codebase. Using custom shell scripts to compile this information became
a cumbersome chore, especially when extracting contexts from multiple repositories. Enter `prompto`, crafted to
alleviate these concerns.

## How does `prompto` work?

`prompto` functions by scanning a predefined list of repositories mentioned in `~/.prompto/config.yaml`. For each
repository, the tool searches for a `prompto/` directory. All files within this directory are treated as prompts,
retrievable using the `prompto get` command. In cases where the file is executable, the `prompto get` command will run
it. Consequently, this allows users to present both static files (documentation, example data) and dynamic prompts (live
commands).

As `prompto` doesn’t intrinsically verify the safety of the commands it executes, users are
strongly cautioned against employing `prompto` on repositories not under their direct control.

## Installation

To install the `prompto` command line tool with homebrew, run:

```bash
  brew tap go-go-golems/go-go-go
  brew install go-go-golems/go-go-go/prompto
  ```

To install the `prompto` command using apt-get, run:

```bash
  echo "deb [trusted=yes] https://apt.fury.io/go-go-golems/ /" >> /etc/apt/sources.list.d/fury.list
  apt-get update
  apt-get install prompto
  ```

To install using `yum`, run:

```bash
  echo "
  [fury]
  name=Gemfury Private Repo
  baseurl=https://yum.fury.io/go-go-golems/
  enabled=1
  gpgcheck=0
  " >> /etc/yum.repos.d/fury.repo
yum install prompto
```

To install using `go get`, run:

```bash
go get -u github.com/go-go-golems/prompto/cmd/prompto
```

Finally, you can install by downloading the binaries straight from [github](https://github.com/go-go-golems/prompto/releases).

```
go get github.com/go-go-golems/prompto
```

## Usage

### Configuring repositories

To configure the repositories for scanning, you can use the following commands:

```bash
# Add repositories
prompto config repositories add /path/to/repo1 /path/to/repo2

# Remove repositories
prompto config repositories remove /path/to/repo1

# List configured repositories
prompto config repositories get
```

These commands will update the `~/.prompto/config.yaml` file automatically.

### Creating prompts in a repository

For `prompto` to recognize prompts within a repository, create a `prompto/` directory at the root of the repository.
Place any desired files (documentation, example data) or executable scripts within this directory, under a subdirectory.

For more information, see [Creating Promptos](03-creating-promptos.md) or run `prompto help create-promptos`.

### Listing available prompts

To view all available prompts, use:

```bash
prompto list
```

### Getting a prompt context

To retrieve the context from a specific prompt, use:

```bash
prompto get [prompt-name]
```

### Web Interface

Prompto also provides a web interface for easier access to your prompts. To start the web server, use:

```bash
prompto serve
```

This will start a local web server, typically on `http://localhost:8080`.

#### Using with Cursor IDE

For using prompto with cursor, see [Cursor Setup](02-cursor-setup.md) or run `prompto help cursor-setup`.

### Safety considerations

Always ensure that repositories added to `prompto` are safe and trusted. As `prompto` doesn't inherently verify the
safety of executed commands, it's vital to be cautious and avoid using repositories that may contain malicious content.

## Examples

To get a glimpse of available prompts:

```
❯ prompto list
/home/manuel/code/wesen/corporate-headquarters/glazed glazed/definitions
/home/manuel/code/wesen/corporate-headquarters/common-sense cms/data/example-flags.md
/home/manuel/code/wesen/corporate-headquarters/common-sense cms/data/form-dsl.yaml
/home/manuel/code/wesen/corporate-headquarters/common-sense cms/data/glazed-types.md
...
```

Retrieve specific contexts:

```
❯ prompto get cms/sql
// Schema is a struct that represents the schema of a CMS object.
  // This contains all the necessary tables, as well as the main table for the object
  // to which all other tables are joined on its `id` using the `parent_id` field.
  //
  // A CMS object is represents by a main table and multiple additional tables used
...
```

```
❯ prompto get glazed/definitions
File: pkg/cmds/cmds.go
  // CommandDescription contains the necessary information for registering
  // a command with cobra. Because a command gets registered in a verb tree,
  // a full list of Parents all the way to the root needs to be provided.
type CommandDescription struct {
...
```

```
❯ prompto get cms/data/plant-dsl.yaml
# This is the main table that represents the plant object
#
#plant:
  help: This table represents a plant object in the CMS
  fields:
...
```

```
 _______  _______    _______  _______ 
|       ||       |  |       ||       |
|    ___||   _   |  |    ___||   _   |
|   | __ |  | |  |  |   | __ |  | |  |
|   ||  ||  |_|  |  |   ||  ||  |_|  |
|   |_| ||       |  |   |_| ||       |
|_______||_______|  |_______||_______|
 _______  _______  ___      _______  __   __  _______ 
|       ||       ||   |    |       ||  |_|  ||       |
|    ___||   _   ||   |    |    ___||       ||  _____|
|   | __ |  | |  ||   |    |   |___ |       || |_____ 
|   ||  ||  |_|  ||   |___ |    ___||       ||_____  |
|   |_| ||       ||       ||   |___ | ||_|| | _____| |
|_______||_______||_______||_______||_|   |_||_______|
 __   __  __    _  ___      _______  _______  _______  __   __ 
|  | |  ||  |  | ||   |    |       ||   _   ||       ||  | |  |
|  | |  ||   |_| ||   |    |    ___||  |_|  ||  _____||  |_|  |
|  |_|  ||       ||   |    |   |___ |       || |_____ |       |
|       ||  _    ||   |___ |    ___||       ||_____  ||       |
|       || | |   ||       ||   |___ |   _   | _____| ||   _   |
|_______||_|  |__||_______||_______||__| |__||_______||__| |__|
 _______  __   __  _______    _______  _______  _     _  _______  ______  
|       ||  | |  ||       |  |       ||       || | _ | ||       ||    _ | 
|_     _||  |_|  ||    ___|  |    _  ||   _   || || || ||    ___||   | || 
  |   |  |       ||   |___   |   |_| ||  | |  ||       ||   |___ |   |_|| 
  |   |  |       ||    ___|  |    ___||  |_|  ||       ||    ___||    __ |
  |   |  |   _   ||   |___   |   |    |       ||   _   ||   |___ |   |  ||
  |___|  |__| |__||_______|  |___|    |_______||__| |__||_______||___|  ||
 _______  _______ 
|       ||       |
|   _   ||    ___|
|  | |  ||   |___ 
|  |_|  ||    ___|
|       ||   |    
|_______||___|    
 _______  _______  __    _  _______  _______  __   __  _______ 
|       ||       ||  |  | ||       ||       ||  |_|  ||       |
|       ||   _   ||   |_| ||_     _||    ___||       ||_     _|
|       ||  | |  ||       |  |   |  |   |___ |       |  |   |  
|      _||  |_|  ||  _    |  |   |  |    ___| |     |   |   |  
|     |_ |       || | |   |  |   |  |   |___ |   _   |  |   |  
|_______||_______||_|  |__|  |___|  |_______||__| |__|  |___|  
 _______  ______   _______  _______  _______  ___   _______  __    _       
|       ||    _ | |       ||   _   ||       ||   | |       ||  |  | |      
|       ||   | || |    ___||  |_|  ||_     _||   | |   _   ||   |_| |      
|       ||   |_|| |   |___ |       |  |   |  |   | |  | |  ||       |      
|      _||    __ ||    ___||       |  |   |  |   | |  |_|  ||  _    | ___  
|     |_ |   |  |||   |___ |   _   |  |   |  |   | |       || | |   ||   | 
|_______||___|  |||_______||__| |__|  |___|  |___| |_______||_|  |__||___| 
```

prompto

prompto Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

prompto

prompto Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README