User guide

1. Dashboard overview

The dashboard is the starting point for queue operations. The status cards summarize queued, running, succeeded, failed and cancelled jobs. The table shows priority, attempts, prompt preview, working directory, attachments, token usage and elapsed time.

• Use status, project, working-directory and starred filters to narrow the list.
• Use pagination controls to change page size, jump to a page, or move to the first/last page.
• Click the job ID to open details. Click the star button to mark/unmark a job without opening it.
• Use Clone to start a new job with the selected prompt and attachments.

2. Projects

Projects group related jobs and provide aggregate counts. Open /projects or choose Projects in the navigation.

1. Create a project with a unique name and an optional description.
2. Mark one project as default using the star control. Only one default project is active at a time.
3. When creating a job, choose a project; if none is selected, the default project is used.
4. Open Jobs on a project row to view only that project’s jobs.

The project dashboard displays total projects, jobs, token usage and status totals before the project list.

3. Rules

Rules are reusable instructions attached to jobs. Manage them at /rules.

• Create or edit a rule with a unique name and Markdown/text content.
• Mark frequently used rules as Default; default rules are pre-selected in the new-job form.
• Search rules by name or content, and export/import rules for reuse across installations.
• Selected rules are inserted between the base prompt and extra prompt when the final prompt is built.

4. Create a job

Open + Add job. Fill in the working directory, project, profile/model and prompt settings, then submit.

1. Choose a Working directory. The Codex CLI runs with this directory as its context.
2. Choose a Profile; the model list is loaded from that profile’s Codex configuration.
3. Write the stable task in Base prompt, select rules, and add one-off instructions in Extra prompt.
4. Set priority (lower values run first), timeout and retry count.
5. Enable Queue first when the job must be placed ahead of other queued jobs.
6. Optionally select a project and attach images/files, then click Add to queue.

The final prompt is assembled automatically as base prompt, selected rules and extra prompt. The most recently used form values are remembered to speed up subsequent job creation.

5. Prompt editor and attachments

• Use the image picker to upload images. You can also paste an image directly from the clipboard into the paste area.
• Use the file picker for any file type supported by the configured upload limits. Files are kept with the job and referenced in the final prompt.
• Preview selected images/files before submitting. Remove an attachment from the preview to exclude it.
• When cloning a job, choose which existing images/files to keep, add new attachments, or remove all.

Do not attach secrets, private keys, credentials or personal data unless the job is explicitly authorized to process them.

6. Edit, clone and prioritize

• Edit is available only while a job is QUEUED. You can change prompt components, rules, project, model, priority, timeout, retries and attachments.
• Clone always creates a new job; it does not modify or rerun the original.
• Queue first or the prioritize action moves a queued job ahead of other queued jobs by lowering its priority number.
• Running or terminal jobs cannot be edited; clone them if a new variant is needed.

7. Job details and lifecycle

The detail page uses tabs so each kind of information remains easy to inspect:

• Final prompt, Base prompt, Rules and Extra prompt.
• Metadata including profile, model, project, working directory, priority and attempts.
• Images and Files attached to the job.
• stdout and stderr logs, with live tailing/auto-scroll while the job runs.

Available actions depend on state:

• QUEUED: edit, prioritize, cancel or kill.
• RUNNING: cancel/kill and monitor logs.
• FAILED: retry when the underlying issue is understood.
• Terminal jobs: clone for a new attempt and review result/logs.

8. Starred jobs and token usage

Click the star control on the dashboard or detail page to mark important jobs. A bright star means is_starred=True; the dim star means it is not starred.

Token usage is shown beside Clone and in the jobs table using compact notation: K (thousand), M (million) and B (billion). The value is parsed from the final Codex output when available.

9. Notifications and remote features

• Configure webhook or Telegram notifications at /config; use the test button before relying on them.
• Notification messages include hostname, project, job ID, result, profile, model, duration and compact token usage.
• Remote jobs sync can periodically import jobs from another queue. Configure endpoint, authentication and filters only when required.
• For programmatic integrations, open API documentation.

10. Common issues