Skip to content

Commit 8950650

Browse files
committed
docs: improved entrypoints' docs for better cli docs
1 parent ab2687c commit 8950650

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

gptme/cli.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,23 @@
4545
docstring = f"""
4646
GPTMe, a chat-CLI for LLMs, enabling them to execute commands and code.
4747
48+
If PROMPTS are provided, a new conversation will be started with it.
49+
50+
If one of the PROMPTS is '{MULTIPROMPT_SEPARATOR}', following prompts will run after the assistant is done answering the first one.
51+
4852
The chat offers some commands that can be used to interact with the system:
4953
5054
\b
5155
{action_readme}"""
5256

5357

5458
@click.command(help=docstring)
55-
@click.argument("prompts", default=None, required=False, nargs=-1)
59+
@click.argument(
60+
"prompts",
61+
default=None,
62+
required=False,
63+
nargs=-1,
64+
)
5665
@click.option(
5766
"--prompt-system",
5867
default="full",

gptme/cli_server.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@
2121
help="Model to use by default, can be overridden in each request.",
2222
)
2323
def main(verbose, llm, model): # pragma: no cover
24-
"""Starts a server and web UI."""
24+
"""
25+
Starts a server and web UI for gptme.
26+
27+
Note that this is very much a work in progress, and is not yet ready for normal use.
28+
"""
2529
init_logging(verbose)
2630
init(llm, model, interactive=False)
2731

0 commit comments

Comments
 (0)