Configuration¶
slurmkit loads configuration in this order:
- CLI flags
- Environment variables
- Project config file at
.slurmkit/config.yaml - Built-in defaults
Config file location¶
The project config file lives at:
Create it with:
Current config shape¶
jobs_dir: .jobs/
output_patterns:
- "{job_name}.{job_id}.out"
- "{job_name}.{job_id}.*.out"
- "slurm-{job_id}.out"
slurm_defaults:
partition: compute
time: "24:00:00"
mem: "16G"
nodes: 1
ntasks: 1
cleanup:
threshold_seconds: 300
min_age_days: 3
ui:
mode: auto
interactive: true
show_banner: true
columns:
collections_show:
- job_name
- job_id
- state
- runtime
- eta_completion
- attempt
- submission_group
- resubmissions
- output_path
collections_show:
pager: less # less | none
notifications:
defaults:
events: [job_failed]
timeout_seconds: 5
max_attempts: 3
backoff_seconds: 0.5
output_tail_lines: 40
job:
ai:
enabled: false
callback: null
collection_final:
attempt_mode: latest
min_support: 3
top_k: 10
include_failed_output_tail_lines: 20
ai:
enabled: false
callback: null
routes: []
wandb:
entity: null
default_projects: []
Derived directories¶
These paths are fixed and derived from the project root. They are not public config keys:
.slurmkit/collections/.slurmkit/sync/.slurmkit/locks/collections/.slurmkit/backups/
jobs_dir is the only top-level path root you configure directly.
Jobs layout¶
Specs define a relative job_subdir (including templated values that resolve to a relative path). slurmkit then derives:
{jobs_dir}/{job_subdir}/job_scripts/{jobs_dir}/{job_subdir}/logs/
Example:
or
This yields:
.jobs/comparisons/model_a/job_scripts/.jobs/comparisons/model_a/logs/
Environment variables¶
| Variable | Description |
|---|---|
SLURMKIT_CONFIG |
Override config file path |
SLURMKIT_JOBS_DIR |
Override jobs_dir |
SLURMKIT_WANDB_ENTITY |
Override wandb.entity |
SLURMKIT_WANDB_PROJECT |
Override wandb.default_project |
SLURMKIT_DRY_RUN |
Enable global dry-run mode |
UI settings¶
ui.mode controls human-readable rendering:
plainrichauto
ui.interactive enables prompt fallback and the command picker when the terminal supports it.
ui.columns.collections_show controls which jobs table columns render in slurmkit collections show.
ui.collections_show.pager controls paging for slurmkit collections show (less or none).
Notifications¶
Global notification settings live under notifications. Collection-specific overrides can also be stored at the top level of a job spec. At notify-time, spec-level notifications override the global config via deep merge.
See Notifications for the route schema and callback examples.