Starting the CLI
Run the following command from the project root:First run
On first launch you will be prompted for a username.Enter a username
Type a username and press Enter. Usernames must:
- Contain only letters, numbers,
_, and- - Be at least 2 characters long
Returning users are recognised by their stored username. All previous sessions are restored automatically at login. Chat history is stored locally in a SQLite database and never sent to a remote server.
Command reference
Every command starts with:. Anything that does not start with : is treated as a query and sent to the RAG pipeline.
| Command | Description |
|---|---|
:help | Print the command reference. |
:ingest <path> [institution] [course] | Embed a document into the knowledge base. |
:sessions | List all sessions with labels and last-active timestamps. |
:new [label] | Create a new session and switch to it immediately. |
:switch <n> | Switch to session number n (1-indexed, as shown by :sessions). |
:history | Show the full chat history for the active session. |
:docs | List all documents ingested in the active session. |
:clear | Delete all chat messages in the active session. |
:q / :quit | Exit Quark. |
| (any other text) | Send as a query to the RAG pipeline. |
Ingesting a file with a path that contains spaces
Wrap the file path in double quotes when it contains spaces:institution argument defaults to "Default" when omitted. The course argument is optional.
See Document ingestion for the full ingestion reference.