It’s finally time! File-based runbooks are coming with the next release, v0.0.94, releasing today. Here’s what you need to know:
What are file-based runbooks?
File-based runbooks are runbooks that live as files on your hard drive, rather than locally in your Atuin database or on Atuin Hub.
While we believe that using online runbooks — which offer real-time collaboration, sync, and backup — is the most frictionless way to manage runbooks, we understand that VCS-based workflows are important too, and this feature enables those workflows.
How do I use file-based runbooks?
Going forward, there are two kinds of workspaces in Atuin Desktop: online workspaces and offline workspaces. Online workspaces will work like current organization workspaces, requiring you to log in to Atuin Hub to create runbooks, enabling real-time collaboration and other features. Offline workspaces will store runbooks as files on your filesystem.
When you create a new workspace, you’ll be prompted to choose which type of workspace to create.
Why am I being prompted to convert my existing workspaces?
When you first open Atuin Desktop v0.0.94 or higher, you will be prompted to convert your existing workspaces to the new online or offline workspaces. Until they are converted, each workspace will be read-only. The conversion process only takes a few seconds and will perform a conversion based on the types of runbooks in the workspace:
- Workspaces with only online runbooks (published to Atuin Hub) will be converted into an online workspace
- Workspaces with only offline runbooks will be converted to an offline workspace
- Workspaces with a mix of online and offline runbooks will be converted into an online workspace, and the offline runbooks will be transferred to a new offline workspace
- Workspaces with no runbooks will be converted to an online workspace
What about markdown-based files?
We’re currently working on markdown-based runbook files, but the format needs a little more time to cook before we’re ready to transition to them. For more information and examples of the markdown format, check out Desktop Devlog - Markdown, Vim, local files and more
Why can’t I transfer runbooks between workspaces?
This feature has been re-enabled in version 0.0.101.
Note: — moving items between workspaces is only supported for workspaces of the same type (online vs offline). Moving items between workspaces of differing types will be available in a future version.