guppi
Version, currently main branch1 version
- main branchlatestJun 24, 2023
github.com/lancecarlson/guppi
No description declared in shard.yml.
Installation
# Add this to your shard.yml
dependencies:
guppi:
github: lancecarlson/guppi
branch: mainmain is a branch, not a release, so this tracks it rather than pinning a version.
Then run:
shards installshard.yml
- Crystal
1.7.2- License
- MIT
- Author
- Lance Carlson
- Target
guppifrom src/guppi.cr
Dependencies
Runtime Dependencies
- crinja*github: straight-shoota/crinja
- openai*github: lancecarlson/openai.cr
- json-schema*github: spider-gazelle/json-schema
README
Guppi
Guppi is a semi-autonomous coding assistant designed to facilitate and streamline your coding process.
GUPPI (or General Unit Primary Peripheral Interface) was named after a "character" from the Bobiverse series.
Installation
make build
sudo make install
Usage
Start by creating a project.md file and writing your project or feature specifications there. Being more descriptive yields better results. A convenient way to do this is to construct it in Chat GPT first. You may find it useful to follow a format similar to the one below, especially for new projects:
Project: guppi
Description: A semi-autonomous coding assistant.
Language: Crystal Lang
Dependencies: openai.cr
<Feature Specification>
To use guppi, run the following command in your terminal:
guppi
This command initiates Guppi. Guppi then generates the next task to complete, based on the project description in your project.md file, as well as the content of relevant files.
When you modify a file, Guppi will create a .edits.extension file and ask if you want to apply the changes.
By default gpt-4 is used. If you want to override and use another model like gpt-3.5-turbo-16k, use the -m flag:
guppi -m gpt-3.5-turbo-16k
Development
To run Guppi during the development phase, use the following command:
crystal run src/guppi.cr
Contributing
If you'd like to contribute to Guppi's development, follow these steps:
- Fork it (https://github.com/lancecarlson/guppi/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Contributors
- Lance Carlson - creator and maintainer
Documentation
Built from the current release. The first visit to a release nobody has asked for starts its build.
Links
This branch
- Branch
main- Seen
- Jun 24, 2023
- Crystal
1.7.2- Indexed
- yes
Dependents
No indexed shard depends on this one yet.
Repository
github.com/lancecarlson/guppi
Metadata
- Created
- Aug 12, 2026
- Updated
- Aug 14, 2026
- Synced
- Aug 14, 2026
- Versions
- 1