Docs
Your first hour in QuirkIDE
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. After that, QuirkIDE keeps itself up to date: see how updates work.
Your first minutes
The first time you open QuirkIDE, Quirki asks how you want to start:
- Start my first project. Pick JavaScript or Python, and a first project in that language opens straight away.
- Open a folder. Bring code you already have. Nothing in it changes.
- I have coded before. Take the placement check, or go straight to Pro.
Each way first asks whether Quirk may learn from how you work. You can change that later in Settings.
The placement check has eight questions at most. Each one shows a short program and asks what it prints. A right answer makes the next question harder, and the check stops early once it knows where you are. Projects then skip what you already know. Quirki offers the check after your first project. Take it any time with Quirk: Take the placement check from the command palette (Ctrl + Shift + P), or skip it: Quirk also learns by watching how you work.
Learn and Pro
QuirkIDE has two modes. Switch at the top right of the title bar, or press Ctrl + Alt + M. Your open files, unsaved work and settings stay as they are.
- Learn shows what a learner needs: your files, Versions and Quirki as tabs over the side bar, one Run button, and an Output sheet for what your program prints. The menus appear when you press Alt. Your work saves as you type.
- Pro adds every developer tool: a row of views on top of the side bar, source control with branches on the right, the terminal, problems and the debugger under the code, the command bar, and the full status bar. Every menu is behind the menu button. Quirki gets smaller and helps when you ask.
Each mode remembers its own layout. In Pro, drag any region somewhere else, or use the layout button. Reset Layout in that menu puts everything back.
Run your code
Select Run in the middle of the title bar, or press F5 in Learn. Run saves the file and runs it: Python with the Python 3 on your computer, JavaScript with Node, or with QuirkIDE's own when Node is not installed. A web page opens in the page view beside the file and updates as you type.
In Learn, what your program prints shows in the Output sheet, under the code or beside it on a wide window. When your program asks a question, type your answer in the box there. When it stops with an error, the sheet says what happened in plain words, the line turns red, and Quirki points at it. In Pro, your program runs in a terminal called Run, and Run has Debug and Run tests beside it.
While a program runs, Run turns into Stop (Shift + F5 in Learn).
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.
Versions
In Learn, the Versions tab keeps snapshots of your work on your computer. Save this version keeps one, What changed shows what is different since the last one, and Go back returns to an earlier version after it saves what you have now. Versions uses Git, so it needs Git on your computer. Pro shows the same history in Git's own words, with branches.
Replay
Replay records how you write a project, key by key. The first time you work in a project, QuirkIDE asks whether to record it. Say yes and the status bar shows Recording. Click it, or run Quirk: Open Replay, to open the Replay page.
- Play it back. Press Play to watch your code being written, or drag the slider to any moment. Marks above the slider show each run of your program, each large paste, and each change that came from outside the editor.
- See what broke it. When your program stops with an error after it worked earlier, QuirkIDE offers What changed since it worked: every line that changed in between, in every file. You can open the same view at any moment on the Replay page.
- Go back. At any earlier moment, Go back to this moment puts that file back to how it was. The version you had stays in the recording, so you can come forward again.
- See where the code came from. The bar at the top shows how much of the code in your files was typed here, pasted, inserted at once (a suggestion or a tool), changed outside the editor, or there before recording began. The same colours mark the code itself.
- Show how you wrote it. What this replay shows reads the recording out in plain facts: how often you ran the program, how many runs failed and were fixed, how often you went back to change earlier code, and how much you took back. If the project uses Git, it shows each commit and whether the recorded files match it character for character, with a link to the commit online. Save a replay file makes one file that plays all of it in any browser, with nothing to install. Send it to a teacher, an employer or a client, next to your GitHub link.
A replay is evidence of how code was written, not proof. Someone determined could type out code they did not write, which is why the page shows how the work went, not only that it was typed. A file typed top to bottom in one pass with almost nothing taken back is pointed out, with the plain reasons that can happen. Replay stays small: keys typed in a row are kept together, a change from outside keeps only what changed, and older parts are compressed, so a long day in a big project takes well under a megabyte. The recording stays in the project's own folder, out of Git unless you choose otherwise, and .env files are never recorded. It keeps what you delete too, so a replay file is for people you would show that to. The privacy page has the details.
Dream a project
Run Quirk: Dream a project and describe what you want to build in a sentence. Quirk turns it into a project in the language you write in: milestone 1 is the smallest version that works, in about 30 minutes, and each feature after it is its own milestone, with checks Quirk runs on your code. Quick mode puts two features in each milestone. If Quirk cannot tell what the idea is for, it asks one question with three likely readings. It also tells you what it cannot teach, such as hardware or app stores, and what the project uses instead. Press Start milestone 1 to open the project. It sits with your other projects, and Dream shows how many milestones you have passed.
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: Run | F5 in Learn |
| Quirk: Stop the running program | Shift + F5 in Learn |
| Quirk: Open the welcome page | |
| Quirk: Take the placement check | |
| Quirk: Open Settings | Ctrl + , |
| Quirk: Take the writing check | |
| Quirk: Open a project | |
| Quirk: Browse projects | |
| Quirk: Pick up where I left off | |
| 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: Open Replay | |
| Quirk: Start or stop recording this project | |
| Quirk: Save a replay file | |
| Quirk: Judge the AI | |
| Quirk: Work with AI | |
| Quirk: Browse concepts | |
| Quirk: Open Quirk | |
| Quirk: Quirki card | |
| 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: Enter your licence key | |
| Quirk: Join QuirkIDE Full | |
| Quirk: Remove the licence from this computer | |
| QuirkIDE: Switch between Learn and Pro | Ctrl + Alt + M |
| QuirkIDE: Reset Layout |
On a keyboard where AltGr and one of these keys types a character, such as µ or ć, AltGr types the character. Press Ctrl and Alt themselves for the shortcut.
Quirk settings
Press Ctrl + , for the Settings page: the mode, the look, writing code, Quirki, privacy, updates and more, in plain groups. Every setting, these included, is also under Pro and advanced, in the editor's own list and in settings.json. There, search for quirk.
| Setting | What it does |
|---|---|
quirk.mode | Learn (the default) or Pro. A mode changes defaults and what the window shows. Anything you set yourself stays as you set it. |
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.replay.record | Whether Replay records how you write your projects: ask for each project (the default), record every project, or never. The recording stays in the project's own folder. |
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 Settings, under Quirki. |
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, JavaScript or Python. Quirk suggests projects in it first, and drills show their code in it. |
quirk.projectsFolder | Where Quirk puts your projects. Empty means a QuirkProjects folder in your home folder. |