Docs
Documentation
How to install Skwir, find your way around and get the most from it. New here? Start with Getting started.
The guide
Getting startedInstall Skwir, take your first steps, and learn what each part of the window does.Browsing and viewsMove around your folders, open tabs and a second pane, and pick the view that suits what you’re looking at.PreviewsSelect a file and Skwir shows what’s inside it, beside the list, without opening another app. Here is what each kind of file can do, and what it needs.SearchingA search in Skwir is a place: come back to it, open it in a tab, keep it in the sidebar. Here is what you can ask for, and how to narrow what it finds.Tags, ratings and commentsGive any file tags, a rating and a comment. Skwir keeps them on the files, where your other applications read them too.Organising filesCopy, move, rename and delete files, gather them on the Shelf, and use Undo. Changes to many files come as a plan you review first.SettingsSettings apply as you change them. Here is what each page sets, how plugins work, which folders stay private, and where Skwir keeps things.Keyboard shortcutsAlmost everything in Skwir has a shortcut. These are the defaults; you can change any of them.Scripts and agentsEverything Skwir does is a named command, and scripts and AI agents can run the same commands in your open window. What they would change comes to you as a plan, and nothing runs until you apply it.TroubleshootingWhat to do when Skwir doesn’t start or a preview is missing, and how to report a problem.Release notesWhat changed in each version of Skwir, newest first.
For contributors
Synced from the app’s repository, which stays their source.
ContributingReport a problem, build Skwir and check a change, and find the rules the code follows.Writing a pluginAdd fields, thumbnails, previews and commands to Skwir, as a WebAssembly module or a program, starting from the template.The plugin protocolWhat Skwir and a plugin from outside say to each other: the manifest, the messages and their limits. Experimental in 0.1.Helping with macOS and WindowsThe macOS and Windows code compiles but has never run. With a Mac or a Windows machine, you can help, step by step.SecurityWhat counts as a security problem in Skwir, and how to report one privately.
In the repository
How Skwir is built is documented beside its code, on GitHub:
- The rules the code follows: Principles and engineering rules, for people and agents alike.
- Decisions: The ADRs: each choice that closed a door, and why.
- Invariants: The binding rules of each area of the code.
- The plan: Phases, their gates, and what is left.