Quickstart tour

A snap is a bundle of one or more applications that works without dependencies or modification across many different Linux distributions. Snaps are discoverable and installable from the Snap Store, a public app store with an audience of millions.

This tour introduces all of snap’s main features. We suggest going through the first few steps and then playing with what you’ve learnt. Come back when you feel comfortable and wish to further your knowledge.

By the end of the tour, you’ll have a good understanding of how to use snaps, from how they’re installed and updated, to how they’re backed-up and removed.


Snaps can be installed and removed with a graphical package manager, such as Ubuntu Software Centre, but most advanced functionality is only available from the Linux command shell.

The command shell is accessible from Terminal and many similar applications. It helps if you have some familiarity with this, but if you don’t, this tour is itself an ideal introduction to get you started.

Many Linux distributions, including Ubuntu, support snap by default. You can check by running the snap command. If the snap command is not found, take a look at our Installation guides for further help.

List installed snaps

Snap is installed with a few other snaps, and a good place to start is to display these with the snap list command:

$ snap list
Name             Version        Rev    Tracking         Publisher   Notes
core22           20231123       1033   latest/stable    canonical✓  base
firefox          120.0.1-1      3504   latest/stable    mozilla✓    -
snapd            2.60.4         20290  latest/stable    canonical✓  snapd

Versions and revisions, under the Version and Rev columns respectively, convey different details about one specific release of a snap:

  • Version : the version of the software being packaged, as assigned by the developers
  • Revision: the sequence number assigned by the store when the snap file was uploaded

The version is a name or number that was arbitrarily assigned to a release by its developers, according to their development practices. It tells the user what content to expect from a snap. The revision is an automatic number assigned by the store to give every snap release a unique identity within the channel across every architecture supported by the snap.

Finding snaps

There are snaps for many popular applications, including Spotify, Slack and the Chromium web browser.

The best way to find new snaps is to use the online Snap Store, either by searching for apps and words you’re interested in, such as “Spotify”, “music” or “maths”, or by browsing through categories.

To search for snaps with ‘media player’ in either their names or descriptions, type snap find "media player" into your terminal:

$ snap find "media player"
Name  Version  Developer    Notes  Summary
vlc   3.0.4     videolan✓   -      The ultimate media player.

The alongside videolan in the above output indicates that the snap publisher has been verified. Verified publishers are trusted to produce and maintain high-quality packages and include institutions, foundations, and companies.

Section categories

Typing snap find without any arguments will return a list of suggested snaps and those suggestions can also be limited to a category with an additional --section= argument. The following section names are valid:

art-and-design books-and-reference development devices-and-iot
education entertainment featured finance
games health-and-fitness music-and-audio news-and-weather
personalisation photo-and-video productivity science
security server-and-cloud social utilities

Learn about a snap

The snap info command makes it easy to find more details about a specific snap. These details include what a snap does, who publishes it, which commands it provides.

The final part of the output lists the channels for the snap:

  latest/stable:    3.0.19                      2023-10-13 (3721) 336MB -
  latest/candidate: 3.0.19                      2023-10-02 (3721) 336MB -
  latest/beta:      3.0.20-27-g795b1bc62b       2023-12-13 (3862) 336MB -
  latest/edge:      4.0.0-dev-26928-g9bc7ded0f0 2023-12-13 (3863) 692MB -
installed:          3.0.19                                 (3721) 336MB -

Channels declare which release of a snap is installed and tracked for updates. The latest/stable channel is used by default, but opting to install from a different channel can be useful for testing new features, or for installing old legacy versions of an application. Which snaps are released to which channels is entirely up to the snap publisher.

Install the snap

Type snap install followed by the name of the snap to install the snap:

sudo snap install vlc

When install is run for the first time, one or more dependencies may be automatically installed alongside the snap you requested. Your network speed will determine how long this process takes. Snap operations can always be safely cancelled with ctrl+c, and one of snap’s best features is that an operation is either wholly successful, or it’s cleanly rolled back to the previous state.

A channel can also be optionally specified with the channel option:

sudo snap install --channel=edge vlc

After installation, the channel being monitored for updates can be changed with:

sudo snap switch --channel=stable vlc

Run apps and commands from the snap

The vast majority of snap-installed applications will run as you expect, from either the command line or from the desktop launcher.

If executing a command directly doesn’t work, use the snap run command:

snap run vlc

Links to snapped applications are located in /snap/bin which is added to the system $PATH.

Update an installed snap

Snaps are updated automatically. However, to manually check for updates, use the following command:

sudo snap refresh vlc

The above will check the channel being tracked by the snap. If a newer version of the snap is available, it will be downloaded and installed.

Changing the channel being tracked and refreshing the snap can be accomplished with a single command:

sudo snap refresh --channel=beta vlc

Updates are automatically installed within 6 hours of a revision being made to a tracked channel, keeping most systems up-to-date. This schedule can be tuned via configuration options and disabled with the --hold option.

Pause or stop automatic updates

The snap refresh --hold command holds, or postpones, snap updates for individual snaps, or for all snaps on the system, either indefinitely or for a specified period of time.

snap refresh --hold=<duration> <snap1> <snap2>...

Time duration units can be seconds (s), minutes (m) or hours (h), or a combination of these. To postpone updates indefinitely, a value of forever is also valid.

$ snap refresh --hold=24h firefox
General refreshes of "firefox" held until 2023-10-26T14:10:53+01:00

If no duration is specified, the hold period defaults to forever.

Refer to Managing updates for more details.

Revert to an earlier revision

A snap may be reverted to an earlier revision with the snap revert command. By default, it will attempt to revert to the previous revision:

$ sudo snap revert vlc
vlc reverted to 3.0.5-1

The optional --revision argument can be specified to request a specific revision:

snap revert vlc --revision 500

This operation will revert both the snap revision and the configuration data associated with the software. If the previously used revision of the snap is from a different channel, that snap will be installed but the channel being tracked won’t change.

User data, such as data generated by the snap and stored in a database, is often stored in a common directory and will not be reverted. See Data locations for more details on what information is stored and where.

A snap won’t automatically update to a version previously reverted from, and the output from snap refresh will continue to state All snaps up to date. A reverted snap will be automatically updated when a new and different revision is made available by the publisher.

However, explicitly adding the snap name to snap refresh will update the snap, regardless of whether the latest revision was previously reverted from or not:

$ snap list --all vlc
Name  Version  Rev  Tracking  Publisher  Notes
vlc   3.0.5-1  768  stable    videolan✓  -
vlc   3.0.6    770  stable    videolan✓  disabled
$ sudo snap refresh
All snaps up to date.
$ sudo snap refresh vlc
vlc 3.0.6 from VideoLAN✓ refreshed

A previously used snap that was reverted from will display disabled in the Notes column of the output.

Connect an interface

Interfaces put you in control of what applications can and cannot do with your system by either permitting denying access to resources outside a snap’s confinement. They’re most commonly used to enable access to a webcam, to permit sound recording, for network access, or to read and write to your $HOME directory or remote storage.

Which interfaces a snap requires, and provides, depends on the type of snap and its own requirements.

To see which interfaces a snap is using, and which interfaces it could use but isn’t, type snap connections <snapname>:

$ snap connections vlc
Interface       Plug                   Slot                 Notes
audio-playback  vlc:audio-playback     :audio-playback      -
audio-record    vlc:audio-record       -                    -
camera          vlc:camera             -                    -
desktop         vlc:desktop            :desktop             -
home            vlc:home               :home                -

The slot is the provider of the resource while the plug is the consumer, and a slot can support multiple plug connections. In the above output, the camera interface is not connected because its slot is empty. This means VLC cannot access any connected cameras. The <snap-name>:<interface-name> syntax describes which snap is responsible for which component. If there’s no snap, such as with :audio-playback, the component is directly connected to the system.

To allow a camera to be accessible to VLC, the interface can be connected with the snap connect command:

snap connect vlc:camera

As you can see the output from snap connections vlc, and in the above image, VLC already has access a user’s /home directory because the home interface is connected to the system $HOME directory. This is an automatic connection, and is granted to certain interfaces and snaps when an interface provides fundamental functionality, such as VLC accessing your personal video and audio files.

Refer to Interfaces for more information.

Where snaps store data

Most snaps use strict confinement. This isolates both their execution environments and their data from your system (see Snap Confinement for further details). A confined snap that needs user-access to files will most likely use the home interface to bridge this confinement gap, allowing you to save and load files from your home directory automatically.

You can see whether the home interface is being used in the output to snap connections <snap name>:

$ snap connections nethack
Interface  Plug          Slot   Notes
home       nethack:home  :home  -

Regardless of whether the home interface is used or not, a snap can also store user data, such as a database or configuration files, within its own directory under $HOME/snap. Data within this snap-specific directory is stored in one of two further directories, depending on whether the data needs to be tied to a specific release, or whether it can be used across multiple releases.

Data for a specific release is stored within a directory named after the revision of a release. This is a numeric value, such as 55 or 56. The data for each specific revision is often copied from one release to the next, so that reverting from one revision to a previous revision will restore a working configuration, for instance. The snap directory also contains a symbolic link called current that points to the snap revision currently active.

Data that can be shared across releases is stored in a directory called common, and might include image or audio caches, or a database. This data is not copied between releases.

For more details on where snaps store their data, see Data locations.

Create and restore a snapshot

A snapshot is a copy of the user, system and configuration data stored by snapd for one or more snaps on your system, and a snapshot of the data found in both $HOME/snap/<snap-name> and /var/snap/<snap-name> is stored in /var/lib/snapd/snapshots/ (see Data locations for more details).

Snapshots are generated manually with the snap save command and automatically when a snap is removed. A snapshot can be used to backup the state of your snaps, revert snaps to a previous state and to restore a fresh snapd installation to a previously saved state.

The snap save command creates a snapshot for all installed snaps, or if declared individually, specific snaps:

$ sudo snap save
Set  Snap         Age    Version               Rev   Size   Notes
30   core         1.00s  16-2.37~pre1          6229   250B  -
30   core18       886ms  18                    543    123B  -
30   go           483ms  1.10.7                3092   387B  -
30   vlc          529ms  3.0.6                 770   882kB  -

The restore command replaces the current user, system and configuration data with the corresponding data from the specified snapshot:

$ sudo snap restore 30
Restored snapshot #30.

By default, this command restores all the data for all the snaps in a snapshot. You can restore data for specific snaps by simply listing them after the command, and for specific users with the --users=<usernames> argument.

Excluding a snap’s system and configuration data from snap restore is not currently possible.

See Snapshots for further details on creating, exporting, importing and validating snapshots.

Remove a snap

To remove a snap from your system, along with its internal user, system and configuration data, use the remove command:

$ sudo snap remove vlc
vlc removed

Add the --no-wait option to return immediately to the command prompt and run the removal in the background.

By default, all of a snap’s revisions are also removed. To remove a specific revision, add the --revision=<revision-number> argument to the remove command.

Prior to removal (except on Ubuntu Core systems), a snap’s internal user, system, and configuration data is saved as a snapshot (snapd 2.39+), and retained for 31 days.

To remove a snap without generating a snapshot, use the additional --purge argument:

$ sudo snap remove vlc --purge
vlc removed

For more details information on using snaps, see our Snap How-to guides.

1 Like

Nice doc :smiley:

A couple of the examples are missing the snap name - for example:

$ snap switch --channel=stable

…should surely be:

$ snap switch --channel=stable vlc ?


$ snap refresh --channel=candidate


1 Like

Thanks! … and fixed!

Great guide.
I am wondering whether “sudo” is needed when trying to install a snap.
If you are running a distro in a virtualized environment, then you need “sudo snap”. Otherwise, you do not.

Is that the case?

I’m not sure I get your question, so please correct me if I’m on the wrong track.

The sudo is needed because in general it seems nice to assume people are not running all commands as root, but instead as their usual user, so the sudo increases the privilege of the command following it to that of the system administrator. That said, when running commands inside a lxd container or similar, the root is more also more isolated and thus more natural, so you might not need it.

I posted a dedicated question at "sudo snap install" or just "snap install"?

(moderation: further content dropped so we move the conversation to your topic)

The ‘$ snap version’ command line output is system dependent i.e. on Ubuntu 18.04 LTS the output is:
snap 2.36.1
snapd 2.36.1
series 16
ubuntu 18.04
kernel 4.15.0-39-generic

Perhaps this could be clarified in the document.

PS: Apologies to all if this entry is mis-placed.

Good point - thanks for letting us know. I’ll update the post (and yes, this is the right place!).


This topic should document the snap run command, just in case one has install multiple distributions of the same command.

A post was split to a new topic: Issues with snap info

This topic should also include the installation and initialization of multipass, since snapcraft defaults to it.

Simply installing the multipass snap is not enough apparently, I had to execute multipass launch to make sure multipass is initialized before running snapcraft. I’m not sure if there is an easier way to initialize multipass.

I think you may mean we need to update Snapcraft overview to show how multipass is initialised? I’ll check with a fresh install and see whether some extra steps are needed. The last time I did this, multipass was installed automatically.

Yes, I’m talking about Snapcraft overview. I’m not sure how my comment ended up on this page. This is what I did:

  1. snap install snapcraft --classic
  2. snap install multipass --classic
  3. snapcraft in the directory of a snap.

Step 3 gave me errors until I executed multipass launch. I’m not sure what happens when you don’t install multipass manually, I have not tried that.

This is in reference to this document: https://snapcraft.io/docs/getting-started

Just pointing out that the image immediately following this text seems to show that the data associated with the snap is retained if it has been modified – which is it?

Thanks for flagging this, and you’re right that the image is misleading. I’ll either update it or replace it, and add further details to the text to make this clearer. The answer actually depends on where the snap stores its data.

If the data is in a common directory (SNAP_USER_COMMON or SNAP_COMMON for the snap developer) then there’s only one instance of the data available across all revisions of the snap, regardless of any revision-specific modifications.

If it’s within a revision-specific folder (SNAP_DATA and SNAP_USER_DATA for the snap developer), then the diagram is correct - data associated with a revision normally migrates forwards, but not backwards after a revert.

Additionally, there’s also data saved in a Snapshot.

This is covered in Data locations, but I agree, it should be simplified and rewritten here.

A couple(?) observations.

  1. Is it worth mentioning the “–verbose” option to “snap info”, as in “snap info --verbose vlc”?

  2. Further down:

"List all available revisions

The following command lists all revisions available for every installed snap, and also highlights which particular revisions are disabled at the moment:

$ snap list --all vlc"

No, that command does not list all revisions “available for every installed snap”, only for vlc.

  1. “Adding /snap/bin to your default $PATH makes running snaps that don’t automatically add themselves more convenient.”

Interestingly, not only should the user not have to do that (on my Ubuntu 22.04 system, that entry is already appended to my PATH) but, oddly, it’s appended twice. As in, it appears that installing snapd somehow adds that directory to one’s PATH twice. Doesn’t hurt, of course, just unnecessary.

  1. Is it worth mentioning the “–no-wait” option for “snap remove”?

Thanks for all these suggestions. I’ve updated the doc to incorporate all of them.

Regarding the discussion of whether or not to keep including “sudo” in sample commands, perhaps early on in this page, add an emphatic note that one can register for a SSO account, then use “snap login” to obviate the need for constant “sudo”.

Good idea. I’ve added some details to the info block explaining the use of sudo. Thanks!

I think the “by” marked bold should be removed.