Usage
Thomas Forgione edited this page 2026-09-17 10:11:38 +02:00

Page revisions

36 Commits

Author SHA1 Message Date
0583389e8b
Say that a tool confirmation takes the view back 2026-09-17 10:11:38 +02:00
ac5974cdc8
Say what scrolling up does while an answer arrives 2026-09-17 10:01:29 +02:00
38321a185b
Say that the gauge fills the window's second half 2026-09-15 12:14:35 +02:00
7b6a4d2b66
Document the context gauge on the bottom bar 2026-09-15 12:05:56 +02:00
567c602051
Document the web tools and the [searxng] table 2026-09-15 11:35:04 +02:00
f38d287bcb
Say that the numpad's Enter opens a line 2026-09-11 17:43:11 +02:00
e32890ccfa
Say what grep does, what it costs and where it stops 2026-09-11 16:45:02 +02:00
62cdcd02fb
Say how a progress bar is shown, and why nothing else gets through 2026-09-11 16:28:44 +02:00
4b5a6b65b0
Say that a command's output appears as it is produced 2026-09-11 16:00:49 +02:00
6ed00dad34
Say what edit_file does and why it refuses what it refuses 2026-09-11 14:57:13 +02:00
e575e69b45
Say that --system sets the prompt from the command line
And what becomes of it: /system replaces it, /clear keeps it, /resume puts
the saved conversation's own in its place.
2026-09-11 13:37:20 +02:00
de11a0cd4f
Describe the shell tool and the container it belongs in
A new page for running papote in Docker: what is in the image, who it runs
as, and what rootless does to the uids -- which is the part that will
surprise somebody. And what the container does not protect, since
providers.toml is mounted into it in clear.
2026-09-11 13:32:34 +02:00
dd8f4f4cfa
Say that Tab adds a message to an answer
Tab beside yes or no opens a message that goes over with the tool's answer,
as your own turn after it.
2026-09-11 12:34:24 +02:00
b34c283ea2
Say that a message typed mid-answer is kept
Enter while the model is talking does not send, and no longer loses what you
typed.
2026-09-11 12:27:37 +02:00
febf58700a
Describe a call being written, and the answers it takes
A tool call is shown as it arrives now, so there is something to say about
watching one. The prompt is a list rather than four letters, there is no
longer an answer that refuses for good, and a tool that has stopped working
is worth knowing to look for in config.toml.
2026-09-11 12:22:38 +02:00
97b02ac1af
Say there is no round limit, and document write_file
max_rounds is configurable and signed, negative meaning no ceiling, which is
the default. Ctrl-C is what stops a turn instead. And the third disk tool
writes.
2026-09-11 11:41:30 +02:00
996f3f513f
Describe the tools papote has, and being asked about them
Three tools now rather than one, two of which read the disk and therefore
stop and ask. Says what the prompt looks like, what each key does, that Esc
is an answer, and how to set the permissions up in advance under [tools].
2026-09-11 11:25:19 +02:00
916e37ef31
Say what the colours on the bar mean
Grey for something that happened, amber for something that did not, red for
something that failed -- and the new warning key in theme.toml.
2026-09-11 10:59:19 +02:00
4dc8a353bb
Say that the thinking is markdown too
It is rendered like an answer now, muted as the base colour and not the only
one.
2026-09-11 10:52:04 +02:00
5645b93f42
Thinking is on by default now
The configuration and usage pages said it was off, and why it was not worth
turning on. Both now say what it is for, and that turning it off is for a
small context.
2026-09-11 09:50:15 +02:00
3b8cd475f3
Document thinking, and the boxes around the asides
A Thinking section on the usage page: what is shown while a model reasons,
that it stays in the conversation, that its tokens count, and that keeping it
costs no context. The tools example gains its boxes too. The configuration
page no longer says turning thinking on buys nothing, and the limitations
page no longer says it is dropped — what remains is that it cannot be folded
away.
2026-09-11 09:47:48 +02:00
c39d32f348
Document tool calling
A Tools section on the usage page: what a tool is for, what the two muted
lines in the conversation are, the one tool there is, the five-round guard,
and the `tools` key with the `--jinja` caveat that makes it worth having.
The configuration page gains the key, and the dependency page the two crates
behind the clock.
2026-09-11 09:38:15 +02:00
e47d6d1e4a
Document pasting an image
A "Pasting one" section: why a file copied in a file manager can be pasted
straight in while a screenshot needs Ctrl-V, what Ctrl-V does with text, and
that a screenshot goes as a flattened JPEG. The keys table gains Ctrl-V, and
the dependency page explains what arboard costs and why its Wayland feature
is the decision rather than the crate.
2026-09-10 21:56:31 +02:00
086b23d77d
Note that a WebP is converted before it is sent
The Images section says why a `.webp` shows as `image/jpeg`: the server
decodes with stb_image, which cannot read WebP at all, so papote converts it
in memory and flattens any transparency onto white. The dependency page
explains what `image` is there for, what it costs, and what was weighed
against it.
2026-09-10 21:41:09 +02:00
baac378d9b
Document walking the candidates with Tab
The Completion section now covers what each press does, the highlight on the
bar and the `selection` colour behind it, Shift-Tab, the list scrolling
rather than being cut, and how to settle a candidate or go into a directory
you cycled onto. The keys table and the theme key list follow.
2026-09-10 21:30:11 +02:00
b19ecfefce
Document Tab completion
A Completion section on the usage page: the two things Tab completes, how
far it grows the line, what the bar shows when the choice is open, and where
Tab is still just a tab. The keys table gains the line.
2026-09-10 21:18:10 +02:00
509eaf4985
Document attaching an image to the message
The Images section follows the new flow: /image hangs a chip on the input
line, the question is written beside it, Enter sends both — and Enter on the
chip alone sends the image by itself. Says which keys take the image back
off the line and why those, and the keys table gains the line.
2026-09-10 20:23:05 +02:00
3b9bd37488
Document /image
An Images section on the usage page: how the path is taken, which formats go,
what the conversation shows in place of a picture it cannot draw, that the
image stays in front of the model for the questions that follow, and the
vision column in the model picker. Notes that a conversation with a
photograph in it is a file with that photograph in it, and that --private
sends one without writing any of it down.
2026-09-10 20:06:37 +02:00
ffb281e7cd
Document /system
A section on the usage page: what it sets, how a multi-line prompt is typed,
what it looks like at the top of the conversation, and the two behaviours
worth knowing — `/clear` keeps the prompt, and a prompt nobody spoke to is
never saved. The conversations page notes that it rides along in the saved
messages, being the first message as far as the API is concerned.
2026-09-10 19:46:32 +02:00
02c6faf0f3
Document the private mode
`papote --private` gets a section of its own on the conversations page: what
it stops writing, what it deliberately still does — the model gets the whole
history, `/model` still writes config.toml — and the indicator in the corner
of the input box. The invocation and the flag go on the usage page, next to
the commands the mode turns off.
2026-09-10 19:33:59 +02:00
1e1ff24fee
Note the fixed-width figures on the bar 2026-09-10 17:57:38 +02:00
5c7cf7b0b1
The token count is a running total, not an increment 2026-09-10 17:53:07 +02:00
eb67105f75
Document the live counters and what the pty harness is for 2026-09-10 17:49:04 +02:00
a8bcad2f7f
Document the bottom bar's numbers, and why there is no context fraction 2026-09-10 17:42:46 +02:00
387d9e0fa9
Document conversation names and /rename 2026-09-10 17:21:31 +02:00
21a9383bdf
Split the README's detail across nine pages, with a sidebar
The README had grown to 279 lines and buried the point under a full
configuration reference. It keeps the pitch, the example and a quick start;
everything else moves here, one page per thing you might actually be looking
for.

_Sidebar.md gives every page the same three-section column: getting started,
using it, under the hood.
2026-09-10 17:09:02 +02:00