QuikRun Configuration

Configuration for QuikRun

quikrun.toml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your quikrun.toml and it validates in your browser — nothing is uploaded.

Validate a quikrun.toml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`$schema`	`string`	Path to the JSON schema
`shell`	`anyOf`	Custom shell to run commands in
`clear_terminal`	`boolean`	Clear the terminal before executing commands default: `true`
`show_time_took`	`boolean`	Show time taken to execute the script default: `true`
`show_command`	`boolean`	Show the actual command that is being run default: `true`
`show_shell`	`boolean`	Show the shell being used for execution default: `true`
`show_divider`	`boolean`	Show the divider line before command stdout/stderr default: `true`
`temp_dir`	`string \| null`	Directory to store temporary execution files default: `null`
`cd_to_file_dir`	`boolean`	Change directory to the folder containing the file before execution default: `false`
`keep_artifacts`	`boolean`	Keep generated binaries or temporary files after execution default: `false`
`auto_close`	`anyOf`	Controls closing behavior after execution
`commands`	`object`	Command Templates by file extension

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
23 properties, 100% carrying a description, max nesting depth 7.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas