QuirkIDEDocs
Your first hour in QuirkIDE
The full guide is on the way. These notes get you from install to your first finished step.
Install
Get QuirkIDE from the download page. It runs on 64-bit Windows 10 and 11. If Windows shows a SmartScreen warning, the download page has the exact clicks.
Take the gauge
The first time you open QuirkIDE, Quirki offers the five-minute gauge. You get up to eight short functions to write. Stuck on one? Select Reveal one to see the next piece, or Leave this one to move on. The gauge stops early when it has seen enough, and it picks your first project.
Run it again at any time with Quirk: Start the gauge from the command palette (Ctrl + Shift + P).
Open a project
Run Quirk: Open a project and pick one from the bank. Quirk makes a real folder for it, in a QuirkProjects folder in your home folder unless you choose another place. Each project splits into milestones, and each milestone has checks.
Once you think a step works, run Quirk: Check this step (Ctrl + Alt + C). Quirk runs the checks against your files and shows you which ones passed.
Get help from Quirki
Press Ctrl + Alt + H, or Ctrl + Alt + N while you type, for a nudge. Ask again, or stay stuck, and the help grows:
- A nudge names the next piece.
- Name the piece explains it in the format that suits you.
- Show the shape shows the shape of the line. You still type it.
- Point at the spot sends Quirki to the exact line.
- Walk through it lists every move in order, and you type each one.
Quirk never pastes code into your file. Set where help starts with the quirk.help.startLevel setting, or turn on quick mode for bigger pieces.
If you paste code, or accept an AI suggestion, Quirki may ask Is this yours?
and check that you can explain one line. Answer it and carry on.
Dream a project
Run Quirk: Dream a project and describe what you want to build in a sentence. Quirk works out the pieces you need, orders them, groups them into milestones and points you to the closest projects in the bank. You can start a track from your sentence.
What Quirk knows about you
Run Quirk: What Quirk knows about you to see your profile: the concepts you know, the formats that help you, and how you work. Correct anything it has wrong. Export it or delete it with the commands below. The privacy policy explains what it holds.
Every Quirk command
Open the command palette with Ctrl + Shift + P and type Quirk.
| Command | Keys |
|---|---|
| Quirk: Welcome and the five-minute gauge | |
| Quirk: Start the gauge | |
| Quirk: Open a project | |
| Quirk: Check this step | Ctrl + Alt + C or Ctrl + Alt + Enter |
| Quirk: Give me a nudge | Ctrl + Alt + H, or Ctrl + Alt + N in the editor |
| Quirk: Point at the spot | |
| Quirk: Dream a project | |
| Quirk: Show the page | |
| Quirk: What Quirk knows about you | |
| Quirk: Export what Quirk knows about you | |
| Quirk: Delete everything Quirk knows about you | |
| Quirk: Choose your Quirki | |
| Quirk: Keep Quirki on screen, or not | |
| Quirk: Choose the QuirkIDE look | |
| Quirk: Choose the language you write in |
Quirk settings
Open Settings with Ctrl + , and search for quirk.
| Setting | What it does |
|---|---|
quirk.watching | Lets Quirk learn from how you work: pauses, deletes, clicks and checks. It stores counts and timings on this computer, never your code. On by default. |
quirk.help.startLevel | The smallest help Quirki gives when you ask, from 1 (a nudge) to 5 (walk through it). |
quirk.quick | The quick path: bigger pieces and fuller hints. Off by default. |
quirk.quirki.stayOnScreen | Keeps Quirki on screen. It wanders while you work and naps when things go quiet. It keeps watching while it naps. |
quirk.quirki.napAfterMinutes | Quiet minutes before an on-screen Quirki falls asleep. 3 by default. |
quirk.character | Which Quirki keeps you company. You can also pick one in the Quirk menu. |
quirk.palette | The QuirkIDE look: Vintage textbook (crimson, ink blue and old gold) or Blanket (soft grey with two pinks). |
quirk.language | The language you write in for function steps: JavaScript or Python. |
quirk.projectsFolder | Where Quirk puts your projects. Empty means a QuirkProjects folder in your home folder. |