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 paths
196 Print system paths
197 The paths command prints the list of paths detected and used by snapd.
199 debug sandbox-features
201 Print sandbox features available on the system
202 The sandbox command prints tags describing features of individual sand‐
204 box components used by snapd on a given system.
205 Usage: snap [OPTIONS] debug sandbox-features [sandbox-features-OPTIONS]
207 --required
209 Ensure that given backend:feature is available
210 debug stacktraces
212 Obtain stacktraces of all snapd goroutines
213 Obtain stacktraces of all snapd goroutines.
215 debug state
217 Inspect a snapd state file.
218 Inspect a snapd state file, bypassing snapd API.
220 Usage: snap [OPTIONS] debug state [state-OPTIONS]
222 --abs-time
224 Display absolute times (in RFC 3339 format). Otherwise, display
225 relative times up to 60 days, then YYYY-MM-DD.
226 --changes
228 List all changes
229 --task ID of the task to inspect
231 --change
233 ID of the change to inspect
234 --check
236 Check change consistency
237 --is-seeded
239 Output seeding status (true or false)
240 --dot Dot (graphviz) output
242 --no-hold
244 Omit tasks in 'Hold' state in the change output
245 debug timings
247 Get the timings of the tasks of a change
248 The timings command displays details about the time each task runs.
250 Usage: snap [OPTIONS] debug timings [timings-OPTIONS]
252 --last Select last change of given type (install, refresh, remove, try,
254 auto-refresh, etc.). A question mark at the end of the type
255 means to do nothing (instead of returning an error) if no change
256 of the given type is found. Note the question mark could need
257 protecting from the shell.
258 --ensure
260 Show timings for a change related to the given Ensure activity
261 (one of: auto-refresh, become-operational, refresh-catalogs, re‐
262 fresh-hints, seed)
263 --all Show timings for all executions of the given Ensure or startup
265 activity, not just the latest
266 --startup
268 Show timings for the startup of given subsystem (one of: load-
269 state, ifacemgr)
270 --verbose
272 Show more information
273 disable
275 Disable a snap in the system
276 The disable command disables a snap. The binaries and services of the
278 snap will no longer be available, but all the data is still available
279 and the snap can easily be enabled again.
280 Usage: snap [OPTIONS] disable [disable-OPTIONS]
282 --no-wait
284 Do not wait for the operation to finish but just print the
285 change id.
286 disconnect
288 Disconnect a plug from a slot
289 The disconnect command disconnects a plug from a slot. It may be
291 called in the following ways:
292 $ snap disconnect <snap>:<plug> <snap>:<slot>
294 Disconnects the specific plug from the specific slot.
296 $ snap disconnect <snap>:<slot or plug>
298 Disconnects everything from the provided plug or slot. The snap name
300 may be omitted for the core snap.
301 When an automatic connection is manually disconnected, its disconnected
303 state is retained after a snap refresh. The --forget flag can be added
304 to the disconnect command to reset this behaviour, and consequently re-
305 enable an automatic reconnection after a snap refresh.
306 Usage: snap [OPTIONS] disconnect [disconnect-OPTIONS]
308 --no-wait
310 Do not wait for the operation to finish but just print the
311 change id.
312 --forget
314 Forget remembered state about the given connection.
315 download
317 Download the given snap
318 The download command downloads the given snap and its supporting asser‐
320 tions to the current directory with .snap and .assert file extensions,
321 respectively.
322 Usage: snap [OPTIONS] download [download-OPTIONS]
324 --channel
326 Use this channel instead of stable
327 --edge Install from the edge channel
329 --beta Install from the beta channel
331 --candidate
333 Install from the candidate channel
334 --stable
336 Install from the stable channel
337 --revision
339 Download the given revision of a snap, to which you must have
340 developer access
341 --basename
343 Use this basename for the snap and assertion files (defaults to
344 <snap>_<revision>)
345 --target-directory
347 Download to this directory (defaults to the current directory)
348 --cohort
350 Download from the given cohort
351 enable
353 Enable a snap in the system
354 The enable command enables a snap that was previously disabled.
356 Usage: snap [OPTIONS] enable [enable-OPTIONS]
358 --no-wait
360 Do not wait for the operation to finish but just print the
361 change id.
362 export-snapshot
364 Export a snapshot
365 Export a snapshot to the given filename.
367 find
369 Find packages to install
370 The find command queries the store for available packages.
372 With the --private flag, which requires the user to be logged-in to the
374 store (see 'snap help login'), it instead searches for private snaps
375 that the user has developer access to, either directly or through the
376 store's collaboration feature.
377 A green check mark (given color and unicode support) after a publisher
379 name indicates that the publisher has been verified.
380 Usage: snap [OPTIONS] find [find-OPTIONS]
382 Aliases: search
385 --private
388 Search private snaps.
389 --narrow
391 Only search for snaps in “stable”.
392 --section [="show-all-sections-please"] <default: "no-section-speci‐
394 fied">
395 Restrict the search to a given section.
396 --color <default: "auto">
398 Use a little bit of color to highlight some things.
399 --unicode <default: "auto">
401 Use a little bit of Unicode to improve legibility.
402 forget
404 Delete a snapshot
405 The forget command deletes a snapshot. This operation can not be un‐
407 done.
408 A snapshot contains archives for the user, system and configuration
410 data of each snap included in the snapshot.
411 By default, this command forgets all the data in a snapshot. Alterna‐
413 tively, you can specify the data of which snaps to forget.
414 Usage: snap [OPTIONS] forget [forget-OPTIONS]
416 --no-wait
418 Do not wait for the operation to finish but just print the
419 change id.
420 get
422 Print configuration options
423 The get command prints configuration options for the provided snap.
425 $ snap get snap-name username
427 frank
428 If multiple option names are provided, the corresponding values are re‐
430 turned:
431 $ snap get snap-name username password
433 Key Value
434 username frank
435 password ...
436 Nested values may be retrieved via a dotted path:
438 $ snap get snap-name author.name
440 frank
441 Usage: snap [OPTIONS] get [get-OPTIONS]
443 -t Strict typing with nulls and quoted strings
445 -d Always return document, even with single key
447 -l Always return list, even with single key
449 help
451 Show help about a command
452 The help command displays information about snap commands.
454 Usage: snap [OPTIONS] help [help-OPTIONS]
456 --all Show a short summary of all commands
458 import-snapshot
460 Import a snapshot
461 Import an exported snapshot set to the system. The snapshot is imported
463 with a new snapshot ID and can be restored using the restore command.
464 Usage: snap [OPTIONS] import-snapshot [import-snapshot-OPTIONS]
466 --abs-time
468 info
470 Show detailed information about snaps
471 The info command shows detailed information about snaps.
473 The snaps can be specified by name or by path; names are looked for
475 both in the store and in the installed snaps; paths can refer to a
476 .snap file, or to a directory that contains an unpacked snap suitable
477 for 'snap try' (an example of this would be the 'prime' directory
478 snapcraft produces).
479 Usage: snap [OPTIONS] info [info-OPTIONS]
481 --color <default: "auto">
483 Use a little bit of color to highlight some things.
484 --unicode <default: "auto">
486 Use a little bit of Unicode to improve legibility.
487 --abs-time
489 Display absolute times (in RFC 3339 format). Otherwise, display
490 relative times up to 60 days, then YYYY-MM-DD.
491 --verbose
493 Include more details on the snap (expanded notes, base, etc.)
494 install
496 Install snaps on the system
497 The install command installs the named snaps on the system.
499 To install multiple instances of the same snap, append an underscore
501 and a unique identifier (for each instance) to a snap's name.
502 With no further options, the snaps are installed tracking the stable
504 channel, with strict security confinement. All available channels of a
505 snap are listed in its 'snap info' output.
506 Revision choice via the --revision override requires the user to have
508 developer access to the snap, either directly or through the store's
509 collaboration feature, and to be logged in (see 'snap help login').
510 Note that a later refresh will typically undo a revision override, tak‐
512 ing the snap back to the current revision of the channel it's tracking.
513 Use --name to set the instance name when installing from snap file.
515 Usage: snap [OPTIONS] install [install-OPTIONS]
517 --color <default: "auto">
519 Use a little bit of color to highlight some things.
520 --unicode <default: "auto">
522 Use a little bit of Unicode to improve legibility.
523 --no-wait
525 Do not wait for the operation to finish but just print the
526 change id.
527 --channel
529 Use this channel instead of stable
530 --edge Install from the edge channel
532 --beta Install from the beta channel
534 --candidate
536 Install from the candidate channel
537 --stable
539 Install from the stable channel
540 --devmode
542 Put snap in development mode and disable security confinement
543 --jailmode
545 Put snap in enforced confinement mode
546 --classic
548 Put snap in classic mode and disable security confinement
549 --revision
551 Install the given revision of a snap, to which you must have de‐
552 veloper access
553 --dangerous
555 Install the given snap file even if there are no pre-acknowl‐
556 edged signatures for it, meaning it was not verified and could
557 be dangerous (--devmode implies this)
558 --unaliased
560 Install the given snap without enabling its automatic aliases
561 --name Install the snap file under the given instance name
563 --cohort
565 Install the snap in the given cohort
566 --ignore-validation
568 Ignore validation by other snaps blocking the installation
569 --transaction <default: "per-snap">
571 Have one transaction per-snap or one for all the specified snaps
572 interface
574 Show details of snap interfaces
575 The interface command shows details of snap interfaces.
577 If no interface name is provided, a list of interface names with at
579 least one connection is shown, or a list of all interfaces if --all is
580 provided.
581 Usage: snap [OPTIONS] interface [interface-OPTIONS]
583 --attrs
585 Show interface attributes
586 --all Include unused interfaces
588 known
590 Show known assertions of the provided type
591 The known command shows known assertions of the provided type. If
593 header=value pairs are provided after the assertion type, the asser‐
594 tions shown must also have the specified headers matching the provided
595 values.
596 Usage: snap [OPTIONS] known [known-OPTIONS]
598 --remote
600 Query the store for the assertion, via snapd if possible
601 --direct
603 Query the store for the assertion, without attempting to go via
604 snapd
605 list
607 List installed snaps
608 The list command displays a summary of snaps installed in the current
610 system.
611 A green check mark (given color and unicode support) after a publisher
613 name indicates that the publisher has been verified.
614 Usage: snap [OPTIONS] list [list-OPTIONS]
616 --all Show all revisions
618 --color <default: "auto">
620 Use a little bit of color to highlight some things.
621 --unicode <default: "auto">
623 Use a little bit of Unicode to improve legibility.
624 login
626 Authenticate to snapd and the store
627 The login command authenticates the user to snapd and the snap store,
629 and saves credentials into the ~/.snap/auth.json file. Further communi‐
630 cation with snapd will then be made using those credentials.
631 It's not necessary to log in to interact with snapd. Doing so, however,
633 enables interactions without sudo, as well as some some developer-ori‐
634 ented features as detailed in the help for the find, install and re‐
635 fresh commands.
636 An account can be set up at https://login.ubuntu.com
638 logout
640 Log out of snapd and the store
641 The logout command logs the current user out of snapd and the store.
643 logs
645 Retrieve logs for services
646 The logs command fetches logs of the given services and displays them
648 in chronological order.
649 Usage: snap [OPTIONS] logs [logs-OPTIONS]
651 --abs-time
653 Display absolute times (in RFC 3339 format). Otherwise, display
654 relative times up to 60 days, then YYYY-MM-DD.
655 -n <default: "10">
657 Show only the given number of lines, or 'all'.
658 -f Wait for new lines and print them as they come in.
660 model
662 Get the active model for this device
663 The model command returns the active model assertion information for
665 this device.
666 By default, only the essential model identification information is in‐
668 cluded in the output, but this can be expanded to include all of an as‐
669 sertion's non-meta headers.
670 The verbose output is presented in a structured, yaml-like format.
672 Similarly, the active serial assertion can be used for the output in‐
674 stead of the model assertion.
675 Usage: snap [OPTIONS] model [model-OPTIONS]
677 --abs-time
679 Display absolute times (in RFC 3339 format). Otherwise, display
680 relative times up to 60 days, then YYYY-MM-DD.
681 --color <default: "auto">
683 Use a little bit of color to highlight some things.
684 --unicode <default: "auto">
686 Use a little bit of Unicode to improve legibility.
687 --serial
689 Print the serial assertion instead of the model assertion.
690 --verbose
692 Print all specific assertion fields.
693 --assertion
695 Print the raw assertion.
696 okay
698 Acknowledge warnings
699 The okay command acknowledges the warnings listed with 'snap warnings'.
701 Once acknowledged a warning won't appear again unless it re-occurrs and
703 sufficient time has passed.
704 pack
706 Pack the given directory as a snap
707 The pack command packs the given snap-dir as a snap and writes the re‐
709 sult to target-dir. If target-dir is omitted, the result is written to
710 current directory. If both source-dir and target-dir are omitted, the
711 pack command packs the current directory.
712 The default file name for a snap can be derived entirely from its
714 snap.yaml, but in some situations it's simpler for a script to feed the
715 filename in. In those cases, --filename can be given to override the
716 default. If this filename is not absolute it will be taken as relative
717 to target-dir.
718 When used with --check-skeleton, pack only checks whether snap-dir con‐
720 tains valid snap metadata and raises an error otherwise. Application
721 commands listed in snap metadata file, but appearing with incorrect
722 permission bits result in an error. Commands that are missing from
723 snap-dir are listed in diagnostic messages.
724 Usage: snap [OPTIONS] pack [pack-OPTIONS]
726 --check-skeleton
728 Validate snap-dir metadata only
729 --filename
731 Output to this filename
732 --compression
734 Compression to use (e.g. xz or lzo)
735 prefer
737 Enable aliases from a snap, disabling any conflicting aliases
738 The prefer command enables all aliases of the given snap in preference
740 to conflicting aliases of other snaps whose aliases will be disabled
741 (or removed, for manual ones).
742 Usage: snap [OPTIONS] prefer [prefer-OPTIONS]
744 --no-wait
746 Do not wait for the operation to finish but just print the
747 change id.
748 prepare-image
750 Prepare a device image
751 The prepare-image command performs some of the steps necessary for cre‐
753 ating device images.
754 For core images it is not invoked directly but usually via ubuntu-im‐
756 age.
757 For preparing classic images it supports a --classic mode
759 Usage: snap [OPTIONS] prepare-image [prepare-image-OPTIONS]
761 --classic
763 Enable classic mode to prepare a classic model image
764 --preseed
766 Preseed (UC20+ only)
767 --preseed-sign-key
769 Name of the key to use to sign preseed assertion, otherwise use
770 the default key
771 --apparmor-features-dir
773 Optional path to apparmor kernel features directory (UC20+ only)
774 --arch Specify an architecture for snaps for --classic when the model
776 does not
777 --channel
779 The channel to use
780 --snap <snap>[=<channel>]
782 Include the given snap from the store or a local file and/or
783 specify the channel to track for the given snap
784 reboot
786 Reboot into selected system and mode
787 The reboot command reboots the system into a particular mode of the se‐
789 lected recovery system.
790 When called without a system label and without a mode it will just
792 trigger a regular reboot.
793 When called without a system label but with a mode it will use the cur‐
795 rent system to enter the given mode.
796 Note that "recover", "factory-reset" and "run" modes are only available
798 for the current system.
799 Usage: snap [OPTIONS] reboot [reboot-OPTIONS]
801 --run Boot into run mode
803 --install
805 Boot into install mode
806 --recover
808 Boot into recover mode
809 --factory-reset
811 Boot into factory-reset mode
812 recovery
814 List available recovery systems
815 The recovery command lists the available recovery systems.
817 With --show-keys it displays recovery keys that can be used to unlock
819 the encrypted partitions if the device-specific automatic unlocking
820 does not work.
821 Usage: snap [OPTIONS] recovery [recovery-OPTIONS]
823 --color <default: "auto">
825 Use a little bit of color to highlight some things.
826 --unicode <default: "auto">
828 Use a little bit of Unicode to improve legibility.
829 --show-keys
831 Show recovery keys (if available) to unlock encrypted parti‐
832 tions.
833 refresh
835 Refresh snaps in the system
836 The refresh command updates the specified snaps, or all snaps in the
838 system if none are specified.
839 With no further options, the snaps are refreshed to the current revi‐
841 sion of the channel they're tracking, preserving their confinement op‐
842 tions. All available channels of a snap are listed in its 'snap info'
843 output.
844 Revision choice via the --revision override requires the user to have
846 developer access to the snap, either directly or through the store's
847 collaboration feature, and to be logged in (see 'snap help login').
848 Note a later refresh will typically undo a revision override.
850 Usage: snap [OPTIONS] refresh [refresh-OPTIONS]
852 --color <default: "auto">
854 Use a little bit of color to highlight some things.
855 --unicode <default: "auto">
857 Use a little bit of Unicode to improve legibility.
858 --abs-time
860 Display absolute times (in RFC 3339 format). Otherwise, display
861 relative times up to 60 days, then YYYY-MM-DD.
862 --no-wait
864 Do not wait for the operation to finish but just print the
865 change id.
866 --channel
868 Use this channel instead of stable
869 --edge Install from the edge channel
871 --beta Install from the beta channel
873 --candidate
875 Install from the candidate channel
876 --stable
878 Install from the stable channel
879 --devmode
881 Put snap in development mode and disable security confinement
882 --jailmode
884 Put snap in enforced confinement mode
885 --classic
887 Put snap in classic mode and disable security confinement
888 --amend
890 Allow refresh attempt on snap unknown to the store
891 --revision
893 Refresh to the given revision, to which you must have developer
894 access
895 --cohort
897 Refresh the snap into the given cohort
898 --leave-cohort
900 Refresh the snap out of its cohort
901 --list Show the new versions of snaps that would be updated with the
903 next refresh
904 --time Show auto refresh information but do not perform a refresh
906 --ignore-validation
908 Ignore validation by other snaps blocking the refresh
909 --transaction <default: "per-snap">
911 Have one transaction per-snap or one for all the specified snaps
912 remove
914 Remove snaps from the system
915 The remove command removes the named snap instance from the system.
917 By default all the snap revisions are removed, including their data and
919 the common data directory. When a --revision option is passed only the
920 specified revision is removed.
921 Unless automatic snapshots are disabled, a snapshot of all data for the
923 snap is saved upon removal, which is then available for future restora‐
924 tion with snap restore. The --purge option disables automatically cre‐
925 ating snapshots.
926 Usage: snap [OPTIONS] remove [remove-OPTIONS]
928 --no-wait
930 Do not wait for the operation to finish but just print the
931 change id.
932 --revision
934 Remove only the given revision
935 --purge
937 Remove the snap without saving a snapshot of its data
938 restart
940 Restart services
941 The restart command restarts the given services.
943 If the --reload option is given, for each service whose app has a
945 reload command, a reload is performed instead of a restart.
946 Usage: snap [OPTIONS] restart [restart-OPTIONS]
948 --no-wait
950 Do not wait for the operation to finish but just print the
951 change id.
952 --reload
954 If the service has a reload command, use it instead of restart‐
955 ing.
956 restore
958 Restore a snapshot
959 The restore command replaces the current user, system and configuration
961 data of included snaps, with the corresponding data from the specified
962 snapshot.
963 By default, this command restores all the data in a snapshot. Alterna‐
965 tively, you can specify the data of which snaps to restore, or for
966 which users, or a combination of these.
967 If a snap is included in a restore operation, excluding its system and
969 configuration data from the restore is not currently possible. This re‐
970 striction may be lifted in the future.
971 Usage: snap [OPTIONS] restore [restore-OPTIONS]
973 --no-wait
975 Do not wait for the operation to finish but just print the
976 change id.
977 --users
979 Restore data of only specific users (comma-separated) (default:
980 all users)
981 revert
983 Reverts the given snap to the previous state
984 The revert command reverts the given snap to its state before the lat‐
986 est refresh. This will reactivate the previous snap revision, and will
987 use the original data that was associated with that revision, discard‐
988 ing any data changes that were done by the latest revision. As an ex‐
989 ception, data which the snap explicitly chooses to share across revi‐
990 sions is not touched by the revert process.
991 Usage: snap [OPTIONS] revert [revert-OPTIONS]
993 --no-wait
995 Do not wait for the operation to finish but just print the
996 change id.
997 --devmode
999 Put snap in development mode and disable security confinement
1000 --jailmode
1002 Put snap in enforced confinement mode
1003 --classic
1005 Put snap in classic mode and disable security confinement
1006 --revision
1008 Revert to the given revision
1009 run
1011 Run the given snap command
1012 The run command executes the given snap command with the right confine‐
1014 ment and environment.
1015 Usage: snap [OPTIONS] run [run-OPTIONS] <NAME-OF-SNAP>.<NAME-OF-APP>
1017 [<SNAP-APP-ARG>...]
1018 --shell
1020 Run a shell instead of the command (useful for debugging)
1021 --debug-log
1023 Enable debug logging during early snap startup phases
1024 --strace [="with-strace"] <default: "no-strace">
1026 Run the command under strace (useful for debugging). Extra
1027 strace options can be specified as well here. Pass --raw to
1028 strace early snap helpers.
1029 --gdbserver [=":0"] <default: "no-gdbserver">
1031 Run the command with gdbserver
1032 --trace-exec
1034 Display exec calls timing data
1035 save
1037 Save a snapshot of the current data
1038 The save command creates a snapshot of the current user, system and
1040 configuration data for the given snaps.
1041 By default, this command saves the data of all snaps for all users.
1043 Alternatively, you can specify the data of which snaps to save, or for
1044 which users, or a combination of these.
1045 If a snap is included in a save operation, excluding its system and
1047 configuration data from the snapshot is not currently possible. This
1048 restriction may be lifted in the future.
1049 Usage: snap [OPTIONS] save [save-OPTIONS]
1051 --no-wait
1053 Do not wait for the operation to finish but just print the
1054 change id.
1055 --abs-time
1057 Display absolute times (in RFC 3339 format). Otherwise, display
1058 short relative times.
1059 --users
1061 Snapshot data of only specific users (comma-separated) (default:
1062 all users)
1063 saved
1065 List currently stored snapshots
1066 The saved command displays a list of snapshots that have been created
1068 previously with the 'save' command.
1069 Usage: snap [OPTIONS] saved [saved-OPTIONS]
1071 --abs-time
1073 Display absolute times (in RFC 3339 format). Otherwise, display
1074 short relative times.
1075 --id Show only a specific snapshot.
1077 services
1079 Query the status of services
1080 The services command lists information about the services specified, or
1082 about the services in all currently installed snaps.
1083 set
1085 Change configuration options
1086 The set command changes the provided configuration options as re‐
1088 quested.
1089 $ snap set snap-name username=frank password=$PASSWORD
1091 All configuration changes are persisted at once, and only after the
1093 snap's configuration hook returns successfully.
1094 Nested values may be modified via a dotted path:
1096 $ snap set snap-name author.name=frank
1098 Configuration option may be unset with exclamation mark:
1100 $ snap set snap-name author!
1101 Usage: snap [OPTIONS] set [set-OPTIONS]
1103 --no-wait
1105 Do not wait for the operation to finish but just print the
1106 change id.
1107 -t Parse the value strictly as JSON document
1109 -s Parse the value as a string
1111 start
1113 Start services
1114 The start command starts, and optionally enables, the given services.
1116 Usage: snap [OPTIONS] start [start-OPTIONS]
1118 --no-wait
1120 Do not wait for the operation to finish but just print the
1121 change id.
1122 --enable
1124 As well as starting the service now, arrange for it to be
1125 started on boot.
1126 stop
1128 Stop services
1129 The stop command stops, and optionally disables, the given services.
1131 Usage: snap [OPTIONS] stop [stop-OPTIONS]
1133 --no-wait
1135 Do not wait for the operation to finish but just print the
1136 change id.
1137 --disable
1139 As well as stopping the service now, arrange for it to no longer
1140 be started on boot.
1141 switch
1143 Switches snap to a different channel
1144 The switch command switches the given snap to a different channel with‐
1146 out doing a refresh. All available channels of a snap are listed in its
1147 'snap info' output.
1148 Usage: snap [OPTIONS] switch [switch-OPTIONS]
1150 --no-wait
1152 Do not wait for the operation to finish but just print the
1153 change id.
1154 --channel
1156 Use this channel instead of stable
1157 --edge Install from the edge channel
1159 --beta Install from the beta channel
1161 --candidate
1163 Install from the candidate channel
1164 --stable
1166 Install from the stable channel
1167 --cohort
1169 Switch the snap into the given cohort
1170 --leave-cohort
1172 Switch the snap out of its cohort
1173 tasks
1175 List a change's tasks
1176 The tasks command displays a summary of tasks associated with an indi‐
1178 vidual change.
1179 Usage: snap [OPTIONS] tasks [tasks-OPTIONS]
1181 Aliases: change
1184 --abs-time
1187 Display absolute times (in RFC 3339 format). Otherwise, display
1188 relative times up to 60 days, then YYYY-MM-DD.
1189 --last Select last change of given type (install, refresh, remove, try,
1191 auto-refresh, etc.). A question mark at the end of the type
1192 means to do nothing (instead of returning an error) if no change
1193 of the given type is found. Note the question mark could need
1194 protecting from the shell.
1195 try
1197 Test an unpacked snap in the system
1198 The try command installs an unpacked snap into the system for testing
1200 purposes. The unpacked snap content continues to be used even after
1201 installation, so non-metadata changes there go live instantly. Metadata
1202 changes such as those performed in snap.yaml will require reinstalla‐
1203 tion to go live.
1204 If snap-dir argument is omitted, the try command will attempt to infer
1206 it if either snapcraft.yaml file and prime directory or meta/snap.yaml
1207 file can be found relative to current working directory.
1208 Usage: snap [OPTIONS] try [try-OPTIONS]
1210 --no-wait
1212 Do not wait for the operation to finish but just print the
1213 change id.
1214 --devmode
1216 Put snap in development mode and disable security confinement
1217 --jailmode
1219 Put snap in enforced confinement mode
1220 --classic
1222 Put snap in classic mode and disable security confinement
1223 unalias
1225 Remove a manual alias, or the aliases for an entire snap
1226 The unalias command removes a single alias if the provided argument is
1228 a manual alias, or disables all aliases of a snap, including manual
1229 ones, if the argument is a snap name.
1230 Usage: snap [OPTIONS] unalias [unalias-OPTIONS]
1232 --no-wait
1234 Do not wait for the operation to finish but just print the
1235 change id.
1236 unset
1238 Remove configuration options
1239 The unset command removes the provided configuration options as re‐
1241 quested.
1242 $ snap unset snap-name name address
1244 All configuration changes are persisted at once, and only after the
1246 snap's configuration hook returns successfully.
1247 Nested values may be removed via a dotted path:
1249 $ snap unset snap-name user.name
1251 Usage: snap [OPTIONS] unset [unset-OPTIONS]
1253 --no-wait
1255 Do not wait for the operation to finish but just print the
1256 change id.
1257 version
1259 Show version details
1260 The version command displays the versions of the running client,
1262 server, and operating system.
1263 wait
1265 Wait for configuration
1266 The wait command waits until a configuration becomes true.
1268 warnings
1270 List warnings
1271 The warnings command lists the warnings that have been reported to the
1273 system.
1274 Once warnings have been listed with 'snap warnings', 'snap okay' may be
1276 used to silence them. A warning that's been silenced in this way will
1277 not be listed again unless it happens again, _and_ a cooldown time has
1278 passed.
1279 Warnings expire automatically, and once expired they are forgotten.
1281 Usage: snap [OPTIONS] warnings [warnings-OPTIONS]
1283 --abs-time
1285 Display absolute times (in RFC 3339 format). Otherwise, display
1286 relative times up to 60 days, then YYYY-MM-DD.
1287 --unicode <default: "auto">
1289 Use a little bit of Unicode to improve legibility.
1290 --all Show all warnings
1292 --verbose
1294 Show more information
1295 watch
1297 Watch a change in progress
1298 The watch command waits for the given change-id to finish and shows
1300 progress (if available).
1301 Usage: snap [OPTIONS] watch [watch-OPTIONS]
1303 --last Select last change of given type (install, refresh, remove, try,
1305 auto-refresh, etc.). A question mark at the end of the type
1306 means to do nothing (instead of returning an error) if no change
1307 of the given type is found. Note the question mark could need
1308 protecting from the shell.
1309 whoami
1311 Show the email the user is logged in with
1312 The whoami command shows the email the user is logged in with.
1314
1317 1. Online documentation
1318 https://docs.snapcraft.io
1319
1321 Please report all bugs with https://bugs.launchpad.net/snapd/+filebug
1322 10 July 2022 snap(8)