-
-
Notifications
You must be signed in to change notification settings - Fork 211
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improved docs structure (User & Dev guide), improved CLI & API …
…Reference, extracted Prompts as new page, added Examples
- Loading branch information
Showing
11 changed files
with
156 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
Are we tiny? | ||
============ | ||
|
||
gptme is intended to be small and simple, and focus on doing the right thing in the right way, rather than all the things in all the ways. | ||
|
||
Since it is built by a single developer, there are limits imposed to how large things can get before it becomes too much to handle. Being aggressive about keeping things small and simple is a way to keep the project maintainable and fun to work on. The fastest way to kill a project is to make it too big and complex, and suffer burnout as a result. | ||
|
||
To that end, in this document we will present some statistics about the current state of the project, trying to be mindful to keep an eye on this page and make sure we are not growing too much. | ||
|
||
|
||
Lines of code | ||
------------- | ||
|
||
LoC Core | ||
******* | ||
|
||
.. command-output:: make -C .. cloc-core | ||
|
||
LoC Tools | ||
********* | ||
|
||
.. command-output:: make -C .. cloc-tools | ||
|
||
LoC Server | ||
*********** | ||
|
||
.. command-output:: make -C .. cloc-server | ||
|
||
LoC Tests | ||
********** | ||
|
||
.. command-output:: make -C .. cloc-tests | ||
|
||
LoC Eval | ||
******** | ||
|
||
.. command-output:: make -C .. cloc-eval | ||
|
||
LoC Total | ||
********* | ||
|
||
.. command-output:: make -C .. cloc-total |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,23 @@ | ||
CLI Reference | ||
============= | ||
|
||
gptme provides the following commands: | ||
|
||
.. contents:: Commands | ||
:depth: 1 | ||
:local: | ||
:backlinks: none | ||
|
||
This is the full CLI reference. For a more concise version, run ``gptme --help``. | ||
|
||
.. click:: gptme.cli:main | ||
:prog: gptme | ||
:nested: full | ||
|
||
.. click:: gptme.server:main | ||
:prog: gptme-server | ||
:nested: full | ||
|
||
.. click:: gptme.eval:main | ||
:prog: gptme-eval | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Examples | ||
======== | ||
|
||
A list of things you can do with gptme. | ||
|
||
To see example output without running the commands yourself, check out the :ref:`demos`. | ||
|
||
|
||
.. code-block:: bash | ||
gptme 'write a web app to particles.html which shows off an impressive and colorful particle effect using three.js' | ||
gptme 'render mandelbrot set to mandelbrot.png' | ||
gptme 'suggest improvements to my vimrc' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Prompts | ||
======= | ||
|
||
Here you can read examples of the system prompts currently used by gptme. | ||
|
||
.. automodule:: gptme.prompts | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters