Initial commit

Author: ibuildthecloud

Makefile

@@ -0,0 +1,3 @@
+GO_TAGS ?= netgo
+build:
+	CGO_ENABLED=0 go build -o bin/gptscript -tags "${GO_TAGS}" -ldflags "-s -w" .

README.md

@@ -0,0 +1,81 @@
+# README for GPT File Syntax
+
+## Overview
+GPT files found in this project use a custom syntax to describe various shell tools and their respective functionalities. Each file contains definitions for tools including their names, descriptions, arguments, and executable code. Below is an explanation of the syntax based on the contents of the GPT files reviewed (`./describe.gpt`, `./summarize-syntax.gpt`, `./tables.gpt`).
+
+## Syntax Description
+
+### General Format
+GPT files follow a structured format that includes a preamble (indicating available tools), followed by metadata (descriptions of each tool), and Bash script examples for the tool's operation. 
+
+Here's the general layout of a GPT file definition:
+```
+Tools: <tool_list>
+<empty_line>
+--- (3 hyphens to separate each tool definition)
+name: <tool_name>
+description: <description_of_tool>
+arg: <argument_description> (Optional and re-occurring)
+<empty_line>
+<executable_code_block>
+```
+
+### Tool Definition Header
+A tool definition always starts with three hyphens (`---`). This is a separator used to distinguish between different tool descriptions within the file.
+
+### Name
+The `name` field defines the name of the tool. It is used to invoke a specific functionality.
+
+### Description
+The `description` field provides a concise explanation of what the tool does.
+
+### Arguments
+The `arg` fields describe the arguments that the tool accepts. Each argument is paired with a brief description. Argument definitions are optional and can be repeated if a tool accepts multiple arguments.
+
+### Executable Code Block
+Following the metadata, an executable code block is provided. It is written in Bash and contains the script to execute the tool's functionality.
+
+### Examples
+Here are examples extracted from the GPT files which follow the syntax described:
+
+#### From `./describe.gpt`
+```
+---
+name: ls
+description: Recursively lists all go files
+
+#!/bin/bash
+
+find . -name '*.go'
+```
+#### From `./summarize-syntax.gpt`
+```
+---
+name: cat
+description: Reads the contents of a file
+arg: file: The filename to read
+
+#!/bin/bash
+
+cat ${ARG_FILE} </dev/null
+```
+#### From `./tables.gpt`
+```
+---
+Name: sqlite
+Description: The sqlite command line program ... to run sqlite command or SQL statements against a database.
+Arg: databaseFile: The filename of the database to open
+Arg: cmd: The sqlite command or sql statement to run.
+
+#!/bin/bash
+
+sqlite3 ${ARG_DATABASEFILE} -cmd "${ARG_CMD}" </dev/null
+```
+
+## Additional Observations
+- The fields and code block are separated by a new line.
+- The arguments are indicated as `arg: argument_name: argument_description`.
+- The executable code is introduced with a `#!/bin/bash` shebang line and is expected to replace the argument placeholders (`${ARG_NAME}`) with actual values during execution.
+
+Please note that this description of the syntax is based on the provided examples and may not cover variations which are not included in those files. Additional GPT files may include diverse structures and should be reviewed to check for consistency with this syntax.
+

examples/describe.gpt

@@ -0,0 +1,49 @@
+Tools: ls, count, summarize, compare
+
+Find the top 10 go files that have to most lines of code. Then summarize each one and provide an overview of what this go program does. I don't want a file by file summary, just one overall summary.
+
+---
+name: compare
+description: Sorts a list of number from smallest to biggest
+arg: list: A comma separated list of numbers to sort
+
+#!/bin/bash
+
+for i in $(echo "${ARG_LIST}" | sed 's/[[,\]]/ /g'); do
+    echo $i
+done | sort -n
+
+---
+name: ls
+description: Recursively lists all go files
+
+#!/bin/bash
+
+find . -name '*.go'
+
+---
+name: count
+description: Count the lines a file
+arg: file: The filename to count the lines of
+
+#!/bin/bash
+
+wc -l "${ARG_FILE}"
+
+---
+name: summarize
+tools: cat
+description: Read a go file
+arg: file: The filename to read
+
+First read the passed file and then summarize it's content into no more than 100 words
+
+
+---
+name: cat
+description: Read a files content
+arg: file: The filename to count the lines of
+
+#!/bin/bash
+
+cat "${ARG_FILE}" </dev/null

examples/summarize-syntax.gpt

@@ -0,0 +1,20 @@
+tools: ls, cat
+
+Read all gpt files and then write a README that describes the syntax of the gpt files
+
+---
+name: ls
+description: list all gpt files
+
+#!/bin/bash
+
+find -name '*.gpt'
+
+---
+name: cat
+description: Reads the contents of a file
+arg: file: The filename to read
+
+#!/bin/bash
+
+cat ${ARG_FILE} </dev/null

examples/tables.gpt

@@ -0,0 +1,15 @@
+Tools: sqlite
+
+I have the file sqlite database file /home/darren/src/openai-cookbook/examples/data/Chinook.db.
+
+What is the table with the most amount of rows in it?
+
+---
+Name: sqlite
+Description: The sqlite command line program. This tool is used to run sqlite command or SQL statements against a database. The result of this tool will be the output of the executed command or statement.
+Arg: databaseFile: The filename of the database to open
+Arg: cmd: The sqlite command or sql statement to run.
+
+#!/bin/bash
+
+sqlite3 ${ARG_DATABASEFILE} -cmd "${ARG_CMD}" </dev/null

generate.go

@@ -0,0 +1,3 @@
+//go:generate go run github.com/acorn-io/baaah/cmd/deepcopy ./pkg/engine/ ./pkg/types/
+
+package main

go.mod

@@ -0,0 +1,48 @@
+module github.com/acorn-io/gptscript
+
+go 1.21.5
+
+require (
+	github.com/acorn-io/baaah v0.0.0-20240119160309-2a58ee757bbd
+	github.com/acorn-io/cmd v0.0.0-20240101193821-66a32bc6b939
+	github.com/adrg/xdg v0.4.0
+	github.com/pterm/pterm v0.12.76
+	github.com/sashabaranov/go-openai v1.18.3
+	github.com/spf13/cobra v1.8.0
+	golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc
+	golang.org/x/sync v0.5.0
+)
+
+require (
+	atomicgo.dev/cursor v0.2.0 // indirect
+	atomicgo.dev/keyboard v0.2.9 // indirect
+	atomicgo.dev/schedule v0.1.0 // indirect
+	github.com/bombsimon/logrusr/v4 v4.0.0 // indirect
+	github.com/containerd/console v1.0.3 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/google/go-containerregistry v0.16.1 // indirect
+	github.com/gookit/color v1.5.4 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/lithammer/fuzzysearch v1.1.8 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
+	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/rogpeppe/go-internal v1.11.0 // indirect
+	github.com/samber/lo v1.38.1 // indirect
+	github.com/samber/slog-logrus v1.0.0 // indirect
+	github.com/sergi/go-diff v1.3.1 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
+	golang.org/x/mod v0.14.0 // indirect
+	golang.org/x/sys v0.16.0 // indirect
+	golang.org/x/term v0.16.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/tools v0.16.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	k8s.io/apimachinery v0.29.0 // indirect
+	k8s.io/klog/v2 v2.110.1 // indirect
+	sigs.k8s.io/controller-runtime v0.16.3 // indirect
+	sigs.k8s.io/controller-tools v0.12.0 // indirect
+)