Cette page n’est pas encore traduite.

Download and back up

This page is for anyone who wants a copy of their instructions on their own computer. You will learn the four ways to download: one instruction's text, one instruction with all its versions, a file for developers, and everything at once.

Download .md is in the Share menu. Download with its history is in the command palette.

Before you start

  • Without an account, you can download the open instruction and export everything kept in your browser.
  • Signed in, you can also download an instruction with all its versions. You need to be able to read the instruction.
  • A download is a copy. Changing or deleting it changes nothing on instruction.md.
What you want Where What you get
The text of one instruction Share ▸ Download .md One .md file
One instruction with every version Command palette ▸ Download with its history (.zip) A .zip file
A file for a developer's registry Command palette ▸ Download as an OCI artifact (.tar) A .tar file
Every instruction at once Settings ▸ General ▸ Storage ▸ Export all (.zip) A .zip file
Everything in your account Your account ▸ Privacy ▸ Download your data A .zip file

Download one instruction as a file

  1. Open the instruction

    Open it in the editor.

  2. Download it

    Press Share at the top right, then Download .md under As a file. Or press Ctrl+Shift+S (⌘⇧S on a Mac).

    Your browser saves a .md file named after the instruction's title.

The file holds the text as it is in the editor now, your draft included. It is plain text, so any text editor opens it. To bring it back into instruction.md, use Open files… in the command palette. Start from a template, a prompt or a file explains how.

Download an instruction with its history

This keeps every published version of one instruction in a single .zip file. You need to be signed in.

  1. Open the instruction

    Open it in the editor.

  2. Open the command palette

    Press Ctrl+K (⌘K on a Mac), or press Search in the side bar.

  3. Choose the download

    Type "history" and choose Download with its history (.zip).

    The editor says "Making the export — it takes a moment". When it is done, your browser saves the file and the editor says "Downloaded" with the file's name.

The .zip has a folder named after the instruction. In it are:

  • the text of every version, one .md file each, such as v1.md and v2.md
  • a record of each version: who published it, when, and its message
  • which version each of its labels points to, such as latest or stable
  • the instruction's details: its name, title, description and who can read it
  • the draft, if you are allowed to read the draft

One export holds at most 64 MB. If an instruction is larger, you get a notification saying the export wasn't made.

Download as an OCI artifact

An OCI artifact is a file format that developers use to keep software in their own storage systems, called registries. This download is for them. If no one has asked you for it, you don't need it.

The command palette lists Download as an OCI artifact (.tar) when both are true:

  • Developer mode is on, in Settings ▸ General ▸ For developers.
  • The instruction has at least one published version.

The file holds every published version, each labeled with its version number and its labels. Developers find what to do with it in Export and back up.

Export everything at once

This makes one .zip file with all your instructions in their projects and folders.

  1. Open Storage

    Go to Settings ▸ General. Under This browser, find Storage and press Open.

  2. Export

    Press Export all (.zip).

    Your browser saves a file named "instructions-" followed by today's date.

You can also choose Export all instructions (.zip) in the command palette.

What it holds depends on where you are:

  • Without an account, it holds the instructions kept in this browser.
  • Signed in, it holds the instructions of the workspace you are in.

Each instruction is one .md file with its current text, in a folder for each project and folder. Empty folders are kept. Instructions in Trash are left out. A sealed instruction is saved locked, as it is stored, so only its key opens it.

Download everything in your account

To get every instruction you own with all its versions, plus your account's details, use Your account ▸ Privacy ▸ Download your data. Your data: privacy switches, download, delete explains what is in it.

Check it worked

Open your browser's downloads. The file is there under the name the editor showed. A .zip opens with your computer's own tools. A .md file opens in any text editor.

If it doesn't work

What you see What to do
"The export didn't work — check your connection and try again" Check that you are online, then choose the download again.
"The export couldn't be made — try again later" Something went wrong while making the file. Wait a few minutes and try again.
"The export is taking a while — your notifications will say when it's ready" The file is still being made. When your notifications say it is ready, choose the same download again.
A notification says "Your export wasn't made" because it is too large The instruction's versions add up to more than 64 MB. Ask a developer to use Export and back up.
Download with its history (.zip) isn't in the command palette Sign in, and open the instruction first. It is only offered for an instruction kept on instruction.md.
Download as an OCI artifact (.tar) isn't in the command palette Turn on Developer mode, and publish a version first.
Still stuck Write to us on Support.

Questions

Is a download a backup I can bring back?

A .md file opens in the editor again with Open files…, as a new instruction. The .zip with its history is a record for you to keep. The editor doesn't read it back. See Download one instruction as a file.

Does the .md file have my latest changes?

Yes. Download .md saves the text as it is in the editor now, including what you haven't published. To keep the published versions, use Download with its history (.zip). See Download an instruction with its history.

Can I download an instruction someone shared with me?

Yes, if you can read it. The history download includes the draft only if you are allowed to read the draft. See Download an instruction with its history.

Does Export all include old versions?

No. Export all saves each instruction's current text. For every version of one instruction, use Download with its history (.zip). For every version of everything you own, use Download your data. See Download everything in your account.

Last checked against the product:

Was this page helpful? Report a problem