Developing the CLI

Documentation

Documentation can be found in three places:

• app.py docstrings & comments
• a Readme: gpt4all-bindings/cli/README.md
• the actual CLI documentation: gpt4all-bindings/python/docs/gpt4all_cli.md

The docstrings are meant for programmatic use. Since the CLI is primarily geared towards users and not to build on top, they're kept terse.

The Readme is mostly meant for users and includes:

• a link to the CLI documentation (on the website)
• a Quickstart section with some guidance on how to get started with a sane setup

The CLI documentation and other documentation are located in the above mentioned docs/ folder. They're in Markdown format and built for the website. Of the three, they should be the most detailed.

Versioning

The version number should now follow the gpt4all PyPI package, so compatibility is more clear.

The one place to change it is the namedtuple called VERSION_INFO.