1snap(8) System Manager's Manual snap(8)
2
6 snap - Tool to interact with snaps
7
9 snap [OPTIONS]
10
12 The snap command lets you install, configure, refresh and remove snaps.
13 Snaps are packages that work across many different Linux distributions,
14 enabling secure delivery and operation of the latest apps and utili‐
15 ties.
16
19 abort
20 Abort a pending change
21 The abort command attempts to abort a change that still has pending
23 tasks.
24 Usage: snap [OPTIONS] abort [abort-OPTIONS]
26 --last Select last change of given type (install, refresh, remove, try,
28 auto-refresh, etc.). A question mark at the end of the type
29 means to do nothing (instead of returning an error) if no change
30 of the given type is found. Note the question mark could need
31 protecting from the shell.
32 ack
34 Add an assertion to the system
35 The ack command tries to add an assertion to the system assertion data‐
37 base.
38 The assertion may also be a newer revision of a pre-existing assertion
40 that it will replace.
41 To succeed the assertion must be valid, its signature verified with a
43 known public key and the assertion consistent with and its prerequisite
44 in the database.
45 alias
47 Set up a manual alias
48 The alias command aliases the given snap application to the given
50 alias.
51 Once this manual alias is setup the respective application command can
53 be invoked just using the alias.
54 Usage: snap [OPTIONS] alias [alias-OPTIONS]
56 --no-wait
58 Do not wait for the operation to finish but just print the
59 change id.
60 aliases
62 List aliases in the system
63 The aliases command lists all aliases available in the system and their
65 status.
66 $ snap aliases <snap>
68 Lists only the aliases defined by the specified snap.
70 An alias noted as undefined means it was explicitly enabled or disabled
72 but is not defined in the current revision of the snap, possibly tempo‐
73 rarily (e.g. because of a revert). This can cleared with 'snap alias
74 --reset'.
75 changes
77 List system changes
78 The changes command displays a summary of system changes performed re‐
80 cently.
81 Usage: snap [OPTIONS] changes [changes-OPTIONS]
83 --abs-time
85 Display absolute times (in RFC 3339 format). Otherwise, display
86 relative times up to 60 days, then YYYY-MM-DD.
87 check-snapshot
89 Check a snapshot
90 The check-snapshot command verifies the user, system and configuration
92 data of the snaps included in the specified snapshot.
93 The check operation runs the same data integrity verification that is
95 performed when a snapshot is restored.
96 By default, this command checks all the data in a snapshot. Alterna‐
98 tively, you can specify the data of which snaps to check, or for which
99 users, or a combination of these.
100 If a snap is included in a check-snapshot operation, excluding its sys‐
102 tem and configuration data from the check is not currently possible.
103 This restriction may be lifted in the future.
104 Usage: snap [OPTIONS] check-snapshot [check-snapshot-OPTIONS]
106 --no-wait
108 Do not wait for the operation to finish but just print the
109 change id.
110 --users
112 Check data of only specific users (comma-separated) (default:
113 all users)
114 connect
116 Connect a plug to a slot
117 The connect command connects a plug to a slot. It may be called in the
119 following ways:
120 $ snap connect <snap>:<plug> <snap>:<slot>
122 Connects the provided plug to the given slot.
124 $ snap connect <snap>:<plug> <snap>
126 Connects the specific plug to the only slot in the provided snap that
128 matches the connected interface. If more than one potential slot ex‐
129 ists, the command fails.
130 $ snap connect <snap>:<plug>
132 Connects the provided plug to the slot in the core snap with a name
134 matching the plug name.
135 Usage: snap [OPTIONS] connect [connect-OPTIONS]
137 --no-wait
139 Do not wait for the operation to finish but just print the
140 change id.
141 connections
143 List interface connections
144 The connections command lists connections between plugs and slots in
146 the system.
147 Unless <snap> is provided, the listing is for connected plugs and slots
149 for all snaps in the system. In this mode, pass --all to also list un‐
150 connected plugs and slots.
151 $ snap connections <snap>
153 Lists connected and unconnected plugs and slots for the specified snap.
155 Usage: snap [OPTIONS] connections [connections-OPTIONS]
157 --all Show connected and unconnected plugs and slots
159 create-cohort
161 Create cohort keys for a set of snaps
162 The create-cohort command creates a set of cohort keys for a given set
164 of snaps.
165 A cohort is a view or snapshot of a snap's "channel map" at a given
167 point in time that fixes the set of revisions for the snap given other
168 constraints (e.g. channel or architecture). The cohort is then identi‐
169 fied by an opaque per-snap key that works across systems. Installations
170 or refreshes of the snap using a given cohort key would use a fixed re‐
171 vision for up to 90 days, after which a new set of revisions would be
172 fixed under that same cohort key and a new 90 days window started.
173 debug
175 Run debug commands
176 The debug command contains a selection of additional sub-commands.
179 Debug commands can be removed without notice and may not work on non-
181 development systems.
182 debug confinement
185 Print the confinement mode the system operates in
186 The confinement command will print the confinement mode (strict, par‐
188 tial or none) the system operates in.
189 debug connectivity
191 Check network connectivity status
192 The connectivity command checks the network connectivity of snapd.
194 debug migrate-home
196 Migrate snaps' directory to ~/Snap.
197 Migrate snaps' directory to ~/Snap.
199 Usage: snap [OPTIONS] debug migrate-home [migrate-home-OPTIONS]
201 --no-wait
203 debug paths
205 Print system paths
206 The paths command prints the list of paths detected and used by snapd.
208 debug sandbox-features
210 Print sandbox features available on the system
211 The sandbox command prints tags describing features of individual sand‐
213 box components used by snapd on a given system.
214 Usage: snap [OPTIONS] debug sandbox-features [sandbox-features-OPTIONS]
216 --required
218 Ensure that given backend:feature is available
219 debug stacktraces
221 Obtain stacktraces of all snapd goroutines
222 Obtain stacktraces of all snapd goroutines.
224 debug state
226 Inspect a snapd state file.
227 Inspect a snapd state file, bypassing snapd API.
229 Usage: snap [OPTIONS] debug state [state-OPTIONS]
231 --abs-time
233 Display absolute times (in RFC 3339 format). Otherwise, display
234 relative times up to 60 days, then YYYY-MM-DD.
235 --changes
237 List all changes
238 --task ID of the task to inspect
240 --change
242 ID of the change to inspect
243 --check
245 Check change consistency
246 --connections
248 List all connections
249 --connection
251 Show details of the matching connections (snap or
252 snap:plug,snap:slot or snap:plug-or-slot
253 --is-seeded
255 Output seeding status (true or false)
256 --dot Dot (graphviz) output
258 --no-hold
260 Omit tasks in 'Hold' state in the change output
261 debug timings
263 Get the timings of the tasks of a change
264 The timings command displays details about the time each task runs.
266 Usage: snap [OPTIONS] debug timings [timings-OPTIONS]
268 --last Select last change of given type (install, refresh, remove, try,
270 auto-refresh, etc.). A question mark at the end of the type
271 means to do nothing (instead of returning an error) if no change
272 of the given type is found. Note the question mark could need
273 protecting from the shell.
274 --ensure
276 Show timings for a change related to the given Ensure activity
277 (one of: auto-refresh, become-operational, refresh-catalogs, re‐
278 fresh-hints, seed)
279 --all Show timings for all executions of the given Ensure or startup
281 activity, not just the latest
282 --startup
284 Show timings for the startup of given subsystem (one of: load-
285 state, ifacemgr)
286 --verbose
288 Show more information
289 disable
291 Disable a snap in the system
292 The disable command disables a snap. The binaries and services of the
294 snap will no longer be available, but all the data is still available
295 and the snap can easily be enabled again.
296 Usage: snap [OPTIONS] disable [disable-OPTIONS]
298 --no-wait
300 Do not wait for the operation to finish but just print the
301 change id.
302 disconnect
304 Disconnect a plug from a slot
305 The disconnect command disconnects a plug from a slot. It may be
307 called in the following ways:
308 $ snap disconnect <snap>:<plug> <snap>:<slot>
310 Disconnects the specific plug from the specific slot.
312 $ snap disconnect <snap>:<slot or plug>
314 Disconnects everything from the provided plug or slot. The snap name
316 may be omitted for the core snap.
317 When an automatic connection is manually disconnected, its disconnected
319 state is retained after a snap refresh. The --forget flag can be added
320 to the disconnect command to reset this behaviour, and consequently re-
321 enable an automatic reconnection after a snap refresh.
322 Usage: snap [OPTIONS] disconnect [disconnect-OPTIONS]
324 --no-wait
326 Do not wait for the operation to finish but just print the
327 change id.
328 --forget
330 Forget remembered state about the given connection.
331 download
333 Download the given snap
334 The download command downloads the given snap and its supporting asser‐
336 tions to the current directory with .snap and .assert file extensions,
337 respectively.
338 Usage: snap [OPTIONS] download [download-OPTIONS]
340 --channel
342 Use this channel instead of stable
343 --edge Install from the edge channel
345 --beta Install from the beta channel
347 --candidate
349 Install from the candidate channel
350 --stable
352 Install from the stable channel
353 --revision
355 Download the given revision of a snap, to which you must have
356 developer access
357 --basename
359 Use this basename for the snap and assertion files (defaults to
360 <snap>_<revision>)
361 --target-directory
363 Download to this directory (defaults to the current directory)
364 --cohort
366 Download from the given cohort
367 enable
369 Enable a snap in the system
370 The enable command enables a snap that was previously disabled.
372 Usage: snap [OPTIONS] enable [enable-OPTIONS]
374 --no-wait
376 Do not wait for the operation to finish but just print the
377 change id.
378 export-snapshot
380 Export a snapshot
381 Export a snapshot to the given filename.
383 find
385 Find packages to install
386 The find command queries the store for available packages.
388 With the --private flag, which requires the user to be logged-in to the
390 store (see 'snap help login'), it instead searches for private snaps
391 that the user has developer access to, either directly or through the
392 store's collaboration feature.
393 A green check mark (given color and unicode support) after a publisher
395 name indicates that the publisher has been verified.
396 Usage: snap [OPTIONS] find [find-OPTIONS]
398 Aliases: search
401 --private
404 Search private snaps.
405 --narrow
407 Only search for snaps in “stable”.
408 --section [="show-all-sections-please"] <default: "no-section-speci‐
410 fied">
411 Restrict the search to a given section.
412 --color <default: "auto">
414 Use a little bit of color to highlight some things.
415 --unicode <default: "auto">
417 Use a little bit of Unicode to improve legibility.
418 forget
420 Delete a snapshot
421 The forget command deletes a snapshot. This operation can not be un‐
423 done.
424 A snapshot contains archives for the user, system and configuration
426 data of each snap included in the snapshot.
427 By default, this command forgets all the data in a snapshot. Alterna‐
429 tively, you can specify the data of which snaps to forget.
430 Usage: snap [OPTIONS] forget [forget-OPTIONS]
432 --no-wait
434 Do not wait for the operation to finish but just print the
435 change id.
436 get
438 Print configuration options
439 The get command prints configuration options for the provided snap.
441 $ snap get snap-name username
443 frank
444 If multiple option names are provided, the corresponding values are re‐
446 turned:
447 $ snap get snap-name username password
449 Key Value
450 username frank
451 password ...
452 Nested values may be retrieved via a dotted path:
454 $ snap get snap-name author.name
456 frank
457 Usage: snap [OPTIONS] get [get-OPTIONS]
459 -t Strict typing with nulls and quoted strings
461 -d Always return document, even with single key
463 -l Always return list, even with single key
465 help
467 Show help about a command
468 The help command displays information about snap commands.
470 Usage: snap [OPTIONS] help [help-OPTIONS]
472 --all Show a short summary of all commands
474 import-snapshot
476 Import a snapshot
477 Import an exported snapshot set to the system. The snapshot is imported
479 with a new snapshot ID and can be restored using the restore command.
480 Usage: snap [OPTIONS] import-snapshot [import-snapshot-OPTIONS]
482 --abs-time
484 info
486 Show detailed information about snaps
487 The info command shows detailed information about snaps.
489 The snaps can be specified by name or by path; names are looked for
491 both in the store and in the installed snaps; paths can refer to a
492 .snap file, or to a directory that contains an unpacked snap suitable
493 for 'snap try' (an example of this would be the 'prime' directory
494 snapcraft produces).
495 Usage: snap [OPTIONS] info [info-OPTIONS]
497 --color <default: "auto">
499 Use a little bit of color to highlight some things.
500 --unicode <default: "auto">
502 Use a little bit of Unicode to improve legibility.
503 --abs-time
505 Display absolute times (in RFC 3339 format). Otherwise, display
506 relative times up to 60 days, then YYYY-MM-DD.
507 --verbose
509 Include more details on the snap (expanded notes, base, etc.)
510 install
512 Install snaps on the system
513 The install command installs the named snaps on the system.
515 To install multiple instances of the same snap, append an underscore
517 and a unique identifier (for each instance) to a snap's name.
518 With no further options, the snaps are installed tracking the stable
520 channel, with strict security confinement. All available channels of a
521 snap are listed in its 'snap info' output.
522 Revision choice via the --revision override requires the user to have
524 developer access to the snap, either directly or through the store's
525 collaboration feature, and to be logged in (see 'snap help login').
526 Note that a later refresh will typically undo a revision override, tak‐
528 ing the snap back to the current revision of the channel it's tracking.
529 Use --name to set the instance name when installing from snap file.
531 Usage: snap [OPTIONS] install [install-OPTIONS]
533 --color <default: "auto">
535 Use a little bit of color to highlight some things.
536 --unicode <default: "auto">
538 Use a little bit of Unicode to improve legibility.
539 --no-wait
541 Do not wait for the operation to finish but just print the
542 change id.
543 --channel
545 Use this channel instead of stable
546 --edge Install from the edge channel
548 --beta Install from the beta channel
550 --candidate
552 Install from the candidate channel
553 --stable
555 Install from the stable channel
556 --devmode
558 Put snap in development mode and disable security confinement
559 --jailmode
561 Put snap in enforced confinement mode
562 --classic
564 Put snap in classic mode and disable security confinement
565 --revision
567 Install the given revision of a snap, to which you must have de‐
568 veloper access
569 --dangerous
571 Install the given snap file even if there are no pre-acknowl‐
572 edged signatures for it, meaning it was not verified and could
573 be dangerous (--devmode implies this)
574 --unaliased
576 Install the given snap without enabling its automatic aliases
577 --name Install the snap file under the given instance name
579 --cohort
581 Install the snap in the given cohort
582 --ignore-validation
584 Ignore validation by other snaps blocking the installation
585 --transaction <default: "per-snap">
587 Have one transaction per-snap or one for all the specified snaps
588 --quota-group
590 Add the snap to a quota group on install
591 interface
593 Show details of snap interfaces
594 The interface command shows details of snap interfaces.
596 If no interface name is provided, a list of interface names with at
598 least one connection is shown, or a list of all interfaces if --all is
599 provided.
600 Usage: snap [OPTIONS] interface [interface-OPTIONS]
602 --attrs
604 Show interface attributes
605 --all Include unused interfaces
607 known
609 Show known assertions of the provided type
610 The known command shows known assertions of the provided type. If
612 header=value pairs are provided after the assertion type, the asser‐
613 tions shown must also have the specified headers matching the provided
614 values.
615 Usage: snap [OPTIONS] known [known-OPTIONS]
617 --remote
619 Query the store for the assertion, via snapd if possible
620 --direct
622 Query the store for the assertion, without attempting to go via
623 snapd
624 list
626 List installed snaps
627 The list command displays a summary of snaps installed in the current
629 system.
630 A green check mark (given color and unicode support) after a publisher
632 name indicates that the publisher has been verified.
633 Usage: snap [OPTIONS] list [list-OPTIONS]
635 --all Show all revisions
637 --color <default: "auto">
639 Use a little bit of color to highlight some things.
640 --unicode <default: "auto">
642 Use a little bit of Unicode to improve legibility.
643 login
645 Authenticate to snapd and the store
646 The login command authenticates the user to snapd and the snap store,
648 and saves credentials into the ~/.snap/auth.json file. Further communi‐
649 cation with snapd will then be made using those credentials.
650 It's not necessary to log in to interact with snapd. Doing so, however,
652 enables interactions without sudo, as well as some some developer-ori‐
653 ented features as detailed in the help for the find, install and re‐
654 fresh commands.
655 An account can be set up at https://login.ubuntu.com
657 logout
659 Log out of snapd and the store
660 The logout command logs the current user out of snapd and the store.
662 logs
664 Retrieve logs for services
665 The logs command fetches logs of the given services and displays them
667 in chronological order.
668 Usage: snap [OPTIONS] logs [logs-OPTIONS]
670 --abs-time
672 Display absolute times (in RFC 3339 format). Otherwise, display
673 relative times up to 60 days, then YYYY-MM-DD.
674 -n <default: "10">
676 Show only the given number of lines, or 'all'.
677 -f Wait for new lines and print them as they come in.
679 model
681 Get the active model for this device
682 The model command returns the active model assertion information for
684 this device.
685 By default, only the essential model identification information is in‐
687 cluded in the output, but this can be expanded to include all of an as‐
688 sertion's non-meta headers.
689 The verbose output is presented in a structured, yaml-like format.
691 Similarly, the active serial assertion can be used for the output in‐
693 stead of the model assertion.
694 Usage: snap [OPTIONS] model [model-OPTIONS]
696 --abs-time
698 Display absolute times (in RFC 3339 format). Otherwise, display
699 relative times up to 60 days, then YYYY-MM-DD.
700 --color <default: "auto">
702 Use a little bit of color to highlight some things.
703 --unicode <default: "auto">
705 Use a little bit of Unicode to improve legibility.
706 --serial
708 Print the serial assertion instead of the model assertion.
709 --verbose
711 Print all specific assertion fields.
712 --assertion
714 Print the raw assertion.
715 okay
717 Acknowledge warnings
718 The okay command acknowledges the warnings listed with 'snap warnings'.
720 Once acknowledged a warning won't appear again unless it re-occurrs and
722 sufficient time has passed.
723 pack
725 Pack the given directory as a snap
726 The pack command packs the given snap-dir as a snap and writes the re‐
728 sult to target-dir. If target-dir is omitted, the result is written to
729 current directory. If both source-dir and target-dir are omitted, the
730 pack command packs the current directory.
731 The default file name for a snap can be derived entirely from its
733 snap.yaml, but in some situations it's simpler for a script to feed the
734 filename in. In those cases, --filename can be given to override the
735 default. If this filename is not absolute it will be taken as relative
736 to target-dir.
737 When used with --check-skeleton, pack only checks whether snap-dir con‐
739 tains valid snap metadata and raises an error otherwise. Application
740 commands listed in snap metadata file, but appearing with incorrect
741 permission bits result in an error. Commands that are missing from
742 snap-dir are listed in diagnostic messages.
743 Usage: snap [OPTIONS] pack [pack-OPTIONS]
745 --check-skeleton
747 Validate snap-dir metadata only
748 --filename
750 Output to this filename
751 --compression
753 Compression to use (e.g. xz or lzo)
754 prefer
756 Enable aliases from a snap, disabling any conflicting aliases
757 The prefer command enables all aliases of the given snap in preference
759 to conflicting aliases of other snaps whose aliases will be disabled
760 (or removed, for manual ones).
761 Usage: snap [OPTIONS] prefer [prefer-OPTIONS]
763 --no-wait
765 Do not wait for the operation to finish but just print the
766 change id.
767 prepare-image
769 Prepare a device image
770 The prepare-image command performs some of the steps necessary for cre‐
772 ating device images.
773 For core images it is not invoked directly but usually via ubuntu-im‐
775 age.
776 For preparing classic images it supports a --classic mode
778 Usage: snap [OPTIONS] prepare-image [prepare-image-OPTIONS]
780 --classic
782 Enable classic mode to prepare a classic model image
783 --preseed
785 Preseed (UC20+ only)
786 --preseed-sign-key
788 Name of the key to use to sign preseed assertion, otherwise use
789 the default key
790 --apparmor-features-dir
792 Optional path to apparmor kernel features directory (UC20+ only)
793 --sysfs-overlay
795 Optional sysfs overlay to be used when running preseeding steps
796 --arch Specify an architecture for snaps for --classic when the model
798 does not
799 --channel
801 The channel to use
802 --snap <snap>[=<channel>]
804 Include the given snap from the store or a local file and/or
805 specify the channel to track for the given snap
806 reboot
808 Reboot into selected system and mode
809 The reboot command reboots the system into a particular mode of the se‐
811 lected recovery system.
812 When called without a system label and without a mode it will just
814 trigger a regular reboot.
815 When called without a system label but with a mode it will use the cur‐
817 rent system to enter the given mode.
818 Note that "recover", "factory-reset" and "run" modes are only available
820 for the current system.
821 Usage: snap [OPTIONS] reboot [reboot-OPTIONS]
823 --run Boot into run mode
825 --install
827 Boot into install mode
828 --recover
830 Boot into recover mode
831 --factory-reset
833 Boot into factory-reset mode
834 recovery
836 List available recovery systems
837 The recovery command lists the available recovery systems.
839 With --show-keys it displays recovery keys that can be used to unlock
841 the encrypted partitions if the device-specific automatic unlocking
842 does not work.
843 Usage: snap [OPTIONS] recovery [recovery-OPTIONS]
845 --color <default: "auto">
847 Use a little bit of color to highlight some things.
848 --unicode <default: "auto">
850 Use a little bit of Unicode to improve legibility.
851 --show-keys
853 Show recovery keys (if available) to unlock encrypted parti‐
854 tions.
855 refresh
857 Refresh snaps in the system
858 The refresh command updates the specified snaps, or all snaps in the
860 system if none are specified.
861 With no further options, the snaps are refreshed to the current revi‐
863 sion of the channel they're tracking, preserving their confinement op‐
864 tions. All available channels of a snap are listed in its 'snap info'
865 output.
866 Revision choice via the --revision override requires the user to have
868 developer access to the snap, either directly or through the store's
869 collaboration feature, and to be logged in (see 'snap help login').
870 Note a later refresh will typically undo a revision override.
872 Hold (--hold) is used to postpone snap refresh updates for all snaps
874 when no snaps are specified, or for the specified snaps.
875 When no snaps are specified --hold is only effective on auto-refreshes
877 and will not block either general refresh requests from 'snap refresh'
878 or specific snap requests from 'snap refresh target-snap'.
879 When snaps are specified --hold is effective on both their auto-re‐
881 freshes and general refresh requests from 'snap refresh'. However, spe‐
882 cific snap requests from 'snap refresh target-snap' remain unblocked
883 and will proceed.
884 Usage: snap [OPTIONS] refresh [refresh-OPTIONS]
886 --color <default: "auto">
888 Use a little bit of color to highlight some things.
889 --unicode <default: "auto">
891 Use a little bit of Unicode to improve legibility.
892 --abs-time
894 Display absolute times (in RFC 3339 format). Otherwise, display
895 relative times up to 60 days, then YYYY-MM-DD.
896 --no-wait
898 Do not wait for the operation to finish but just print the
899 change id.
900 --channel
902 Use this channel instead of stable
903 --edge Install from the edge channel
905 --beta Install from the beta channel
907 --candidate
909 Install from the candidate channel
910 --stable
912 Install from the stable channel
913 --devmode
915 Put snap in development mode and disable security confinement
916 --jailmode
918 Put snap in enforced confinement mode
919 --classic
921 Put snap in classic mode and disable security confinement
922 --amend
924 Allow refresh attempt on snap unknown to the store
925 --revision
927 Refresh to the given revision, to which you must have developer
928 access
929 --cohort
931 Refresh the snap into the given cohort
932 --leave-cohort
934 Refresh the snap out of its cohort
935 --list Show the new versions of snaps that would be updated with the
937 next refresh
938 --time Show auto refresh information but do not perform a refresh
940 --ignore-validation
942 Ignore validation by other snaps blocking the refresh
943 --transaction <default: "per-snap">
945 Have one transaction per-snap or one for all the specified snaps
946 --hold [="forever"]
948 Hold refreshes for a specified duration (or forever, if no value
949 is specified)
950 --unhold
952 Remove refresh hold
953 remove
955 Remove snaps from the system
956 The remove command removes the named snap instance from the system.
958 By default all the snap revisions are removed, including their data and
960 the common data directory. When a --revision option is passed only the
961 specified revision is removed.
962 Unless automatic snapshots are disabled, a snapshot of all data for the
964 snap is saved upon removal, which is then available for future restora‐
965 tion with snap restore. The --purge option disables automatically cre‐
966 ating snapshots.
967 Usage: snap [OPTIONS] remove [remove-OPTIONS]
969 --no-wait
971 Do not wait for the operation to finish but just print the
972 change id.
973 --revision
975 Remove only the given revision
976 --purge
978 Remove the snap without saving a snapshot of its data
979 restart
981 Restart services
982 The restart command restarts the given services.
984 If the --reload option is given, for each service whose app has a
986 reload command, a reload is performed instead of a restart.
987 Usage: snap [OPTIONS] restart [restart-OPTIONS]
989 --no-wait
991 Do not wait for the operation to finish but just print the
992 change id.
993 --reload
995 If the service has a reload command, use it instead of restart‐
996 ing.
997 restore
999 Restore a snapshot
1000 The restore command replaces the current user, system and configuration
1002 data of included snaps, with the corresponding data from the specified
1003 snapshot.
1004 By default, this command restores all the data in a snapshot. Alterna‐
1006 tively, you can specify the data of which snaps to restore, or for
1007 which users, or a combination of these.
1008 If a snap is included in a restore operation, excluding its system and
1010 configuration data from the restore is not currently possible. This re‐
1011 striction may be lifted in the future.
1012 Usage: snap [OPTIONS] restore [restore-OPTIONS]
1014 --no-wait
1016 Do not wait for the operation to finish but just print the
1017 change id.
1018 --users
1020 Restore data of only specific users (comma-separated) (default:
1021 all users)
1022 revert
1024 Reverts the given snap to the previous state
1025 The revert command reverts the given snap to its state before the lat‐
1027 est refresh. This will reactivate the previous snap revision, and will
1028 use the original data that was associated with that revision, discard‐
1029 ing any data changes that were done by the latest revision. As an ex‐
1030 ception, data which the snap explicitly chooses to share across revi‐
1031 sions is not touched by the revert process.
1032 Usage: snap [OPTIONS] revert [revert-OPTIONS]
1034 --no-wait
1036 Do not wait for the operation to finish but just print the
1037 change id.
1038 --devmode
1040 Put snap in development mode and disable security confinement
1041 --jailmode
1043 Put snap in enforced confinement mode
1044 --classic
1046 Put snap in classic mode and disable security confinement
1047 --revision
1049 Revert to the given revision
1050 run
1052 Run the given snap command
1053 The run command executes the given snap command with the right confine‐
1055 ment and environment.
1056 Usage: snap [OPTIONS] run [run-OPTIONS] <NAME-OF-SNAP>.<NAME-OF-APP>
1058 [<SNAP-APP-ARG>...]
1059 --shell
1061 Run a shell instead of the command (useful for debugging)
1062 --debug-log
1064 Enable debug logging during early snap startup phases
1065 --strace [="with-strace"] <default: "no-strace">
1067 Run the command under strace (useful for debugging). Extra
1068 strace options can be specified as well here. Pass --raw to
1069 strace early snap helpers.
1070 --gdbserver [=":0"] <default: "no-gdbserver">
1072 Run the command with gdbserver
1073 --trace-exec
1075 Display exec calls timing data
1076 save
1078 Save a snapshot of the current data
1079 The save command creates a snapshot of the current user, system and
1081 configuration data for the given snaps.
1082 By default, this command saves the data of all snaps for all users.
1084 Alternatively, you can specify the data of which snaps to save, or for
1085 which users, or a combination of these.
1086 If a snap is included in a save operation, excluding its system and
1088 configuration data from the snapshot is not currently possible. This
1089 restriction may be lifted in the future.
1090 Usage: snap [OPTIONS] save [save-OPTIONS]
1092 --no-wait
1094 Do not wait for the operation to finish but just print the
1095 change id.
1096 --abs-time
1098 Display absolute times (in RFC 3339 format). Otherwise, display
1099 short relative times.
1100 --users
1102 Snapshot data of only specific users (comma-separated) (default:
1103 all users)
1104 saved
1106 List currently stored snapshots
1107 The saved command displays a list of snapshots that have been created
1109 previously with the 'save' command.
1110 Usage: snap [OPTIONS] saved [saved-OPTIONS]
1112 --abs-time
1114 Display absolute times (in RFC 3339 format). Otherwise, display
1115 short relative times.
1116 --id Show only a specific snapshot.
1118 services
1120 Query the status of services
1121 The services command lists information about the services specified, or
1123 about the services in all currently installed snaps.
1124 set
1126 Change configuration options
1127 The set command changes the provided configuration options as re‐
1129 quested.
1130 $ snap set snap-name username=frank password=$PASSWORD
1132 All configuration changes are persisted at once, and only after the
1134 snap's configuration hook returns successfully.
1135 Nested values may be modified via a dotted path:
1137 $ snap set snap-name author.name=frank
1139 Configuration option may be unset with exclamation mark:
1141 $ snap set snap-name author!
1142 Usage: snap [OPTIONS] set [set-OPTIONS]
1144 --no-wait
1146 Do not wait for the operation to finish but just print the
1147 change id.
1148 -t Parse the value strictly as JSON document
1150 -s Parse the value as a string
1152 start
1154 Start services
1155 The start command starts, and optionally enables, the given services.
1157 Usage: snap [OPTIONS] start [start-OPTIONS]
1159 --no-wait
1161 Do not wait for the operation to finish but just print the
1162 change id.
1163 --enable
1165 As well as starting the service now, arrange for it to be
1166 started on boot.
1167 stop
1169 Stop services
1170 The stop command stops, and optionally disables, the given services.
1172 Usage: snap [OPTIONS] stop [stop-OPTIONS]
1174 --no-wait
1176 Do not wait for the operation to finish but just print the
1177 change id.
1178 --disable
1180 As well as stopping the service now, arrange for it to no longer
1181 be started on boot.
1182 switch
1184 Switches snap to a different channel
1185 The switch command switches the given snap to a different channel with‐
1187 out doing a refresh. All available channels of a snap are listed in its
1188 'snap info' output.
1189 Usage: snap [OPTIONS] switch [switch-OPTIONS]
1191 --no-wait
1193 Do not wait for the operation to finish but just print the
1194 change id.
1195 --channel
1197 Use this channel instead of stable
1198 --edge Install from the edge channel
1200 --beta Install from the beta channel
1202 --candidate
1204 Install from the candidate channel
1205 --stable
1207 Install from the stable channel
1208 --cohort
1210 Switch the snap into the given cohort
1211 --leave-cohort
1213 Switch the snap out of its cohort
1214 tasks
1216 List a change's tasks
1217 The tasks command displays a summary of tasks associated with an indi‐
1219 vidual change.
1220 Usage: snap [OPTIONS] tasks [tasks-OPTIONS]
1222 Aliases: change
1225 --abs-time
1228 Display absolute times (in RFC 3339 format). Otherwise, display
1229 relative times up to 60 days, then YYYY-MM-DD.
1230 --last Select last change of given type (install, refresh, remove, try,
1232 auto-refresh, etc.). A question mark at the end of the type
1233 means to do nothing (instead of returning an error) if no change
1234 of the given type is found. Note the question mark could need
1235 protecting from the shell.
1236 try
1238 Test an unpacked snap in the system
1239 The try command installs an unpacked snap into the system for testing
1241 purposes. The unpacked snap content continues to be used even after
1242 installation, so non-metadata changes there go live instantly. Metadata
1243 changes such as those performed in snap.yaml will require reinstalla‐
1244 tion to go live.
1245 If snap-dir argument is omitted, the try command will attempt to infer
1247 it if either snapcraft.yaml file and prime directory or meta/snap.yaml
1248 file can be found relative to current working directory.
1249 Usage: snap [OPTIONS] try [try-OPTIONS]
1251 --no-wait
1253 Do not wait for the operation to finish but just print the
1254 change id.
1255 --devmode
1257 Put snap in development mode and disable security confinement
1258 --jailmode
1260 Put snap in enforced confinement mode
1261 --classic
1263 Put snap in classic mode and disable security confinement
1264 unalias
1266 Remove a manual alias, or the aliases for an entire snap
1267 The unalias command removes a single alias if the provided argument is
1269 a manual alias, or disables all aliases of a snap, including manual
1270 ones, if the argument is a snap name.
1271 Usage: snap [OPTIONS] unalias [unalias-OPTIONS]
1273 --no-wait
1275 Do not wait for the operation to finish but just print the
1276 change id.
1277 unset
1279 Remove configuration options
1280 The unset command removes the provided configuration options as re‐
1282 quested.
1283 $ snap unset snap-name name address
1285 All configuration changes are persisted at once, and only after the
1287 snap's configuration hook returns successfully.
1288 Nested values may be removed via a dotted path:
1290 $ snap unset snap-name user.name
1292 Usage: snap [OPTIONS] unset [unset-OPTIONS]
1294 --no-wait
1296 Do not wait for the operation to finish but just print the
1297 change id.
1298 version
1300 Show version details
1301 The version command displays the versions of the running client,
1303 server, and operating system.
1304 wait
1306 Wait for configuration
1307 The wait command waits until a configuration becomes true.
1309 warnings
1311 List warnings
1312 The warnings command lists the warnings that have been reported to the
1314 system.
1315 Once warnings have been listed with 'snap warnings', 'snap okay' may be
1317 used to silence them. A warning that's been silenced in this way will
1318 not be listed again unless it happens again, _and_ a cooldown time has
1319 passed.
1320 Warnings expire automatically, and once expired they are forgotten.
1322 Usage: snap [OPTIONS] warnings [warnings-OPTIONS]
1324 --abs-time
1326 Display absolute times (in RFC 3339 format). Otherwise, display
1327 relative times up to 60 days, then YYYY-MM-DD.
1328 --unicode <default: "auto">
1330 Use a little bit of Unicode to improve legibility.
1331 --all Show all warnings
1333 --verbose
1335 Show more information
1336 watch
1338 Watch a change in progress
1339 The watch command waits for the given change-id to finish and shows
1341 progress (if available).
1342 Usage: snap [OPTIONS] watch [watch-OPTIONS]
1344 --last Select last change of given type (install, refresh, remove, try,
1346 auto-refresh, etc.). A question mark at the end of the type
1347 means to do nothing (instead of returning an error) if no change
1348 of the given type is found. Note the question mark could need
1349 protecting from the shell.
1350 whoami
1352 Show the email the user is logged in with
1353 The whoami command shows the email the user is logged in with.
1355
1358 1. Online documentation
1359 https://docs.snapcraft.io
1360
1362 Please report all bugs with https://bugs.launchpad.net/snapd/+filebug
1363 25 February 2023 snap(8)