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
80 recently.
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
129 exists, 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
150 unconnected 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
171 revision 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 state
212 Inspect a snapd state file.
213 Inspect a snapd state file, bypassing snapd API.
215 Usage: snap [OPTIONS] debug state [state-OPTIONS]
217 --abs-time
219 Display absolute times (in RFC 3339 format). Otherwise, display
220 relative times up to 60 days, then YYYY-MM-DD.
221 --changes
223 List all changes
224 --task ID of the task to inspect
226 --change
228 ID of the change to inspect
229 --is-seeded
231 Output seeding status (true or false)
232 --dot Dot (graphviz) output
234 --no-hold
236 Omit tasks in 'Hold' state in the change output
237 debug timings
239 Get the timings of the tasks of a change
240 The timings command displays details about the time each task runs.
242 Usage: snap [OPTIONS] debug timings [timings-OPTIONS]
244 --last Select last change of given type (install, refresh, remove, try,
246 auto-refresh, etc.). A question mark at the end of the type
247 means to do nothing (instead of returning an error) if no change
248 of the given type is found. Note the question mark could need
249 protecting from the shell.
250 --ensure
252 Show timings for a change related to the given Ensure activity
253 (one of: auto-refresh, become-operational, refresh-catalogs,
254 refresh-hints, seed)
255 --all Show timings for all executions of the given Ensure or startup
257 activity, not just the latest
258 --startup
260 Show timings for the startup of given subsystem (one of: load-
261 state, ifacemgr)
262 --verbose
264 Show more information
265 disable
267 Disable a snap in the system
268 The disable command disables a snap. The binaries and services of the
270 snap will no longer be available, but all the data is still available
271 and the snap can easily be enabled again.
272 Usage: snap [OPTIONS] disable [disable-OPTIONS]
274 --no-wait
276 Do not wait for the operation to finish but just print the
277 change id.
278 disconnect
280 Disconnect a plug from a slot
281 The disconnect command disconnects a plug from a slot. It may be
283 called in the following ways:
284 $ snap disconnect <snap>:<plug> <snap>:<slot>
286 Disconnects the specific plug from the specific slot.
288 $ snap disconnect <snap>:<slot or plug>
290 Disconnects everything from the provided plug or slot. The snap name
292 may be omitted for the core snap.
293 When an automatic connection is manually disconnected, its disconnected
295 state is retained after a snap refresh. The --forget flag can be added
296 to the disconnect command to reset this behaviour, and consequently re-
297 enable an automatic reconnection after a snap refresh.
298 Usage: snap [OPTIONS] disconnect [disconnect-OPTIONS]
300 --no-wait
302 Do not wait for the operation to finish but just print the
303 change id.
304 --forget
306 Forget remembered state about the given connection.
307 download
309 Download the given snap
310 The download command downloads the given snap and its supporting asser‐
312 tions to the current directory with .snap and .assert file extensions,
313 respectively.
314 Usage: snap [OPTIONS] download [download-OPTIONS]
316 --channel
318 Use this channel instead of stable
319 --edge Install from the edge channel
321 --beta Install from the beta channel
323 --candidate
325 Install from the candidate channel
326 --stable
328 Install from the stable channel
329 --revision
331 Download the given revision of a snap, to which you must have
332 developer access
333 --basename
335 Use this basename for the snap and assertion files (defaults to
336 <snap>_<revision>)
337 --target-directory
339 Download to this directory (defaults to the current directory)
340 --cohort
342 Download from the given cohort
343 enable
345 Enable a snap in the system
346 The enable command enables a snap that was previously disabled.
348 Usage: snap [OPTIONS] enable [enable-OPTIONS]
350 --no-wait
352 Do not wait for the operation to finish but just print the
353 change id.
354 export-snapshot
356 Export a snapshot
357 Export a snapshot to the given filename.
359 find
361 Find packages to install
362 The find command queries the store for available packages.
364 With the --private flag, which requires the user to be logged-in to the
366 store (see 'snap help login'), it instead searches for private snaps
367 that the user has developer access to, either directly or through the
368 store's collaboration feature.
369 A green check mark (given color and unicode support) after a publisher
371 name indicates that the publisher has been verified.
372 Usage: snap [OPTIONS] find [find-OPTIONS]
374 Aliases: search
377 --private
380 Search private snaps.
381 --narrow
383 Only search for snaps in “stable”.
384 --section [="show-all-sections-please"] <default: "no-section-speci‐
386 fied">
387 Restrict the search to a given section.
388 --color <default: "auto">
390 Use a little bit of color to highlight some things.
391 --unicode <default: "auto">
393 Use a little bit of Unicode to improve legibility.
394 forget
396 Delete a snapshot
397 The forget command deletes a snapshot. This operation can not be
399 undone.
400 A snapshot contains archives for the user, system and configuration
402 data of each snap included in the snapshot.
403 By default, this command forgets all the data in a snapshot. Alterna‐
405 tively, you can specify the data of which snaps to forget.
406 Usage: snap [OPTIONS] forget [forget-OPTIONS]
408 --no-wait
410 Do not wait for the operation to finish but just print the
411 change id.
412 get
414 Print configuration options
415 The get command prints configuration options for the provided snap.
417 $ snap get snap-name username
419 frank
420 If multiple option names are provided, the corresponding values are
422 returned:
423 $ snap get snap-name username password
425 Key Value
426 username frank
427 password ...
428 Nested values may be retrieved via a dotted path:
430 $ snap get snap-name author.name
432 frank
433 Usage: snap [OPTIONS] get [get-OPTIONS]
435 -t Strict typing with nulls and quoted strings
437 -d Always return document, even with single key
439 -l Always return list, even with single key
441 help
443 Show help about a command
444 The help command displays information about snap commands.
446 Usage: snap [OPTIONS] help [help-OPTIONS]
448 --all Show a short summary of all commands
450 import-snapshot
452 Import a snapshot
453 Import an exported snapshot set to the system. The snapshot is imported
455 with a new snapshot ID and can be restored using the restore command.
456 Usage: snap [OPTIONS] import-snapshot [import-snapshot-OPTIONS]
458 --abs-time
460 info
462 Show detailed information about snaps
463 The info command shows detailed information about snaps.
465 The snaps can be specified by name or by path; names are looked for
467 both in the store and in the installed snaps; paths can refer to a
468 .snap file, or to a directory that contains an unpacked snap suitable
469 for 'snap try' (an example of this would be the 'prime' directory
470 snapcraft produces).
471 Usage: snap [OPTIONS] info [info-OPTIONS]
473 --color <default: "auto">
475 Use a little bit of color to highlight some things.
476 --unicode <default: "auto">
478 Use a little bit of Unicode to improve legibility.
479 --abs-time
481 Display absolute times (in RFC 3339 format). Otherwise, display
482 relative times up to 60 days, then YYYY-MM-DD.
483 --verbose
485 Include more details on the snap (expanded notes, base, etc.)
486 install
488 Install snaps on the system
489 The install command installs the named snaps on the system.
491 To install multiple instances of the same snap, append an underscore
493 and a unique identifier (for each instance) to a snap's name.
494 With no further options, the snaps are installed tracking the stable
496 channel, with strict security confinement.
497 Revision choice via the --revision override requires the user to have
499 developer access to the snap, either directly or through the store's
500 collaboration feature, and to be logged in (see 'snap help login').
501 Note that a later refresh will typically undo a revision override, tak‐
503 ing the snap back to the current revision of the channel it's tracking.
504 Use --name to set the instance name when installing from snap file.
506 Usage: snap [OPTIONS] install [install-OPTIONS]
508 --color <default: "auto">
510 Use a little bit of color to highlight some things.
511 --unicode <default: "auto">
513 Use a little bit of Unicode to improve legibility.
514 --no-wait
516 Do not wait for the operation to finish but just print the
517 change id.
518 --channel
520 Use this channel instead of stable
521 --edge Install from the edge channel
523 --beta Install from the beta channel
525 --candidate
527 Install from the candidate channel
528 --stable
530 Install from the stable channel
531 --devmode
533 Put snap in development mode and disable security confinement
534 --jailmode
536 Put snap in enforced confinement mode
537 --classic
539 Put snap in classic mode and disable security confinement
540 --revision
542 Install the given revision of a snap, to which you must have
543 developer access
544 --dangerous
546 Install the given snap file even if there are no pre-acknowl‐
547 edged signatures for it, meaning it was not verified and could
548 be dangerous (--devmode implies this)
549 --unaliased
551 Install the given snap without enabling its automatic aliases
552 --name Install the snap file under the given instance name
554 --cohort
556 Install the snap in the given cohort
557 interface
559 Show details of snap interfaces
560 The interface command shows details of snap interfaces.
562 If no interface name is provided, a list of interface names with at
564 least one connection is shown, or a list of all interfaces if --all is
565 provided.
566 Usage: snap [OPTIONS] interface [interface-OPTIONS]
568 --attrs
570 Show interface attributes
571 --all Include unused interfaces
573 known
575 Show known assertions of the provided type
576 The known command shows known assertions of the provided type. If
578 header=value pairs are provided after the assertion type, the asser‐
579 tions shown must also have the specified headers matching the provided
580 values.
581 Usage: snap [OPTIONS] known [known-OPTIONS]
583 --remote
585 Query the store for the assertion, via snapd if possible
586 --direct
588 Query the store for the assertion, without attempting to go via
589 snapd
590 list
592 List installed snaps
593 The list command displays a summary of snaps installed in the current
595 system.
596 A green check mark (given color and unicode support) after a publisher
598 name indicates that the publisher has been verified.
599 Usage: snap [OPTIONS] list [list-OPTIONS]
601 --all Show all revisions
603 --color <default: "auto">
605 Use a little bit of color to highlight some things.
606 --unicode <default: "auto">
608 Use a little bit of Unicode to improve legibility.
609 login
611 Authenticate to snapd and the store
612 The login command authenticates the user to snapd and the snap store,
614 and saves credentials into the ~/.snap/auth.json file. Further communi‐
615 cation with snapd will then be made using those credentials.
616 It's not necessary to log in to interact with snapd. Doing so, however,
618 enables purchasing of snaps using 'snap buy', as well as some some
619 developer-oriented features as detailed in the help for the find,
620 install and refresh commands.
621 An account can be set up at https://login.ubuntu.com
623 logout
625 Log out of snapd and the store
626 The logout command logs the current user out of snapd and the store.
628 logs
630 Retrieve logs for services
631 The logs command fetches logs of the given services and displays them
633 in chronological order.
634 Usage: snap [OPTIONS] logs [logs-OPTIONS]
636 -n <default: "10">
638 Show only the given number of lines, or 'all'.
639 -f Wait for new lines and print them as they come in.
641 model
643 Get the active model for this device
644 The model command returns the active model assertion information for
646 this device.
647 By default, only the essential model identification information is
649 included in the output, but this can be expanded to include all of an
650 assertion's non-meta headers.
651 The verbose output is presented in a structured, yaml-like format.
653 Similarly, the active serial assertion can be used for the output
655 instead of the model assertion.
656 Usage: snap [OPTIONS] model [model-OPTIONS]
658 --abs-time
660 Display absolute times (in RFC 3339 format). Otherwise, display
661 relative times up to 60 days, then YYYY-MM-DD.
662 --color <default: "auto">
664 Use a little bit of color to highlight some things.
665 --unicode <default: "auto">
667 Use a little bit of Unicode to improve legibility.
668 --serial
670 Print the serial assertion instead of the model assertion.
671 --verbose
673 Print all specific assertion fields.
674 --assertion
676 Print the raw assertion.
677 okay
679 Acknowledge warnings
680 The okay command acknowledges the warnings listed with 'snap warnings'.
682 Once acknowledged a warning won't appear again unless it re-occurrs and
684 sufficient time has passed.
685 pack
687 Pack the given directory as a snap
688 The pack command packs the given snap-dir as a snap and writes the
690 result to target-dir. If target-dir is omitted, the result is written
691 to current directory. If both source-dir and target-dir are omitted,
692 the pack command packs the current directory.
693 The default file name for a snap can be derived entirely from its
695 snap.yaml, but in some situations it's simpler for a script to feed the
696 filename in. In those cases, --filename can be given to override the
697 default. If this filename is not absolute it will be taken as relative
698 to target-dir.
699 When used with --check-skeleton, pack only checks whether snap-dir con‐
701 tains valid snap metadata and raises an error otherwise. Application
702 commands listed in snap metadata file, but appearing with incorrect
703 permission bits result in an error. Commands that are missing from
704 snap-dir are listed in diagnostic messages.
705 Usage: snap [OPTIONS] pack [pack-OPTIONS]
707 --check-skeleton
709 Validate snap-dir metadata only
710 --filename
712 Output to this filename
713 prefer
715 Enable aliases from a snap, disabling any conflicting aliases
716 The prefer command enables all aliases of the given snap in preference
718 to conflicting aliases of other snaps whose aliases will be disabled
719 (or removed, for manual ones).
720 Usage: snap [OPTIONS] prefer [prefer-OPTIONS]
722 --no-wait
724 Do not wait for the operation to finish but just print the
725 change id.
726 prepare-image
728 Prepare a device image
729 The prepare-image command performs some of the steps necessary for cre‐
731 ating device images.
732 For core images it is not invoked directly but usually via ubuntu-
734 image.
735 For preparing classic images it supports a --classic mode
737 Usage: snap [OPTIONS] prepare-image [prepare-image-OPTIONS]
739 --classic
741 Enable classic mode to prepare a classic model image
742 --arch Specify an architecture for snaps for --classic when the model
744 does not
745 --channel
747 The channel to use
748 --snap <snap>[=<channel>]
750 Include the given snap from the store or a local file and/or
751 specify the channel to track for the given snap
752 reboot
754 Reboot into selected system and mode
755 The reboot command reboots the system into a particular mode of the
757 selected recovery system.
758 When called without a system label and without a mode it will just
760 trigger a regular reboot.
761 When called without a system label but with a mode it will use the cur‐
763 rent system to enter the given mode.
764 Note that "recover" and "run" modes are only available for the current
766 system.
767 Usage: snap [OPTIONS] reboot [reboot-OPTIONS]
769 --run Boot into run mode
771 --install
773 Boot into install mode
774 --recover
776 Boot into recover mode
777 recovery
779 List available recovery systems
780 The recovery command lists the available recovery systems.
782 With --show-keys it displays recovery keys that can be used to unlock
784 the encrypted partitions if the device-specific automatic unlocking
785 does not work.
786 Usage: snap [OPTIONS] recovery [recovery-OPTIONS]
788 --color <default: "auto">
790 Use a little bit of color to highlight some things.
791 --unicode <default: "auto">
793 Use a little bit of Unicode to improve legibility.
794 --show-keys
796 Show recovery keys (if available) to unlock encrypted parti‐
797 tions.
798 refresh
800 Refresh snaps in the system
801 The refresh command updates the specified snaps, or all snaps in the
803 system if none are specified.
804 With no further options, the snaps are refreshed to the current revi‐
806 sion of the channel they're tracking, preserving their confinement
807 options.
808 Revision choice via the --revision override requires the user to have
810 developer access to the snap, either directly or through the store's
811 collaboration feature, and to be logged in (see 'snap help login').
812 Note a later refresh will typically undo a revision override.
814 Usage: snap [OPTIONS] refresh [refresh-OPTIONS]
816 --color <default: "auto">
818 Use a little bit of color to highlight some things.
819 --unicode <default: "auto">
821 Use a little bit of Unicode to improve legibility.
822 --abs-time
824 Display absolute times (in RFC 3339 format). Otherwise, display
825 relative times up to 60 days, then YYYY-MM-DD.
826 --no-wait
828 Do not wait for the operation to finish but just print the
829 change id.
830 --channel
832 Use this channel instead of stable
833 --edge Install from the edge channel
835 --beta Install from the beta channel
837 --candidate
839 Install from the candidate channel
840 --stable
842 Install from the stable channel
843 --devmode
845 Put snap in development mode and disable security confinement
846 --jailmode
848 Put snap in enforced confinement mode
849 --classic
851 Put snap in classic mode and disable security confinement
852 --amend
854 Allow refresh attempt on snap unknown to the store
855 --revision
857 Refresh to the given revision, to which you must have developer
858 access
859 --cohort
861 Refresh the snap into the given cohort
862 --leave-cohort
864 Refresh the snap out of its cohort
865 --list Show the new versions of snaps that would be updated with the
867 next refresh
868 --time Show auto refresh information but do not perform a refresh
870 --ignore-validation
872 Ignore validation by other snaps blocking the refresh
873 remove
875 Remove snaps from the system
876 The remove command removes the named snap instance from the system.
878 By default all the snap revisions are removed, including their data and
880 the common data directory. When a --revision option is passed only the
881 specified revision is removed.
882 Unless automatic snapshots are disabled, a snapshot of all data for the
884 snap is saved upon removal, which is then available for future restora‐
885 tion with snap restore. The --purge option disables automatically cre‐
886 ating snapshots.
887 Usage: snap [OPTIONS] remove [remove-OPTIONS]
889 --no-wait
891 Do not wait for the operation to finish but just print the
892 change id.
893 --revision
895 Remove only the given revision
896 --purge
898 Remove the snap without saving a snapshot of its data
899 restart
901 Restart services
902 The restart command restarts the given services.
904 If the --reload option is given, for each service whose app has a
906 reload command, a reload is performed instead of a restart.
907 Usage: snap [OPTIONS] restart [restart-OPTIONS]
909 --no-wait
911 Do not wait for the operation to finish but just print the
912 change id.
913 --reload
915 If the service has a reload command, use it instead of restart‐
916 ing.
917 restore
919 Restore a snapshot
920 The restore command replaces the current user, system and configuration
922 data of included snaps, with the corresponding data from the specified
923 snapshot.
924 By default, this command restores all the data in a snapshot. Alterna‐
926 tively, you can specify the data of which snaps to restore, or for
927 which users, or a combination of these.
928 If a snap is included in a restore operation, excluding its system and
930 configuration data from the restore is not currently possible. This
931 restriction may be lifted in the future.
932 Usage: snap [OPTIONS] restore [restore-OPTIONS]
934 --no-wait
936 Do not wait for the operation to finish but just print the
937 change id.
938 --users
940 Restore data of only specific users (comma-separated) (default:
941 all users)
942 revert
944 Reverts the given snap to the previous state
945 The revert command reverts the given snap to its state before the lat‐
947 est refresh. This will reactivate the previous snap revision, and will
948 use the original data that was associated with that revision, discard‐
949 ing any data changes that were done by the latest revision. As an
950 exception, data which the snap explicitly chooses to share across revi‐
951 sions is not touched by the revert process.
952 Usage: snap [OPTIONS] revert [revert-OPTIONS]
954 --no-wait
956 Do not wait for the operation to finish but just print the
957 change id.
958 --devmode
960 Put snap in development mode and disable security confinement
961 --jailmode
963 Put snap in enforced confinement mode
964 --classic
966 Put snap in classic mode and disable security confinement
967 --revision
969 Revert to the given revision
970 run
972 Run the given snap command
973 The run command executes the given snap command with the right confine‐
975 ment and environment.
976 Usage: snap [OPTIONS] run [run-OPTIONS]
978 --shell
980 Run a shell instead of the command (useful for debugging)
981 --strace [="with-strace"] <default: "no-strace">
983 Run the command under strace (useful for debugging). Extra
984 strace options can be specified as well here. Pass --raw to
985 strace early snap helpers.
986 --gdb Run the command with gdb
988 --experimental-gdbserver [=":0"] <default: "no-gdbserver">
990 Run the command with gdbserver (experimental)
991 --trace-exec
993 Display exec calls timing data
994 save
996 Save a snapshot of the current data
997 The save command creates a snapshot of the current user, system and
999 configuration data for the given snaps.
1000 By default, this command saves the data of all snaps for all users.
1002 Alternatively, you can specify the data of which snaps to save, or for
1003 which users, or a combination of these.
1004 If a snap is included in a save operation, excluding its system and
1006 configuration data from the snapshot is not currently possible. This
1007 restriction may be lifted in the future.
1008 Usage: snap [OPTIONS] save [save-OPTIONS]
1010 --no-wait
1012 Do not wait for the operation to finish but just print the
1013 change id.
1014 --abs-time
1016 Display absolute times (in RFC 3339 format). Otherwise, display
1017 short relative times.
1018 --users
1020 Snapshot data of only specific users (comma-separated) (default:
1021 all users)
1022 saved
1024 List currently stored snapshots
1025 The saved command displays a list of snapshots that have been created
1027 previously with the 'save' command.
1028 Usage: snap [OPTIONS] saved [saved-OPTIONS]
1030 --abs-time
1032 Display absolute times (in RFC 3339 format). Otherwise, display
1033 short relative times.
1034 --id Show only a specific snapshot.
1036 services
1038 Query the status of services
1039 The services command lists information about the services specified, or
1041 about the services in all currently installed snaps.
1042 set
1044 Change configuration options
1045 The set command changes the provided configuration options as
1047 requested.
1048 $ snap set snap-name username=frank password=$PASSWORD
1050 All configuration changes are persisted at once, and only after the
1052 snap's configuration hook returns successfully.
1053 Nested values may be modified via a dotted path:
1055 $ snap set snap-name author.name=frank
1057 Configuration option may be unset with exclamation mark:
1059 $ snap set snap-name author!
1060 Usage: snap [OPTIONS] set [set-OPTIONS]
1062 --no-wait
1064 Do not wait for the operation to finish but just print the
1065 change id.
1066 start
1068 Start services
1069 The start command starts, and optionally enables, the given services.
1071 Usage: snap [OPTIONS] start [start-OPTIONS]
1073 --no-wait
1075 Do not wait for the operation to finish but just print the
1076 change id.
1077 --enable
1079 As well as starting the service now, arrange for it to be
1080 started on boot.
1081 stop
1083 Stop services
1084 The stop command stops, and optionally disables, the given services.
1086 Usage: snap [OPTIONS] stop [stop-OPTIONS]
1088 --no-wait
1090 Do not wait for the operation to finish but just print the
1091 change id.
1092 --disable
1094 As well as stopping the service now, arrange for it to no longer
1095 be started on boot.
1096 switch
1098 Switches snap to a different channel
1099 The switch command switches the given snap to a different channel with‐
1101 out doing a refresh.
1102 Usage: snap [OPTIONS] switch [switch-OPTIONS]
1104 --no-wait
1106 Do not wait for the operation to finish but just print the
1107 change id.
1108 --channel
1110 Use this channel instead of stable
1111 --edge Install from the edge channel
1113 --beta Install from the beta channel
1115 --candidate
1117 Install from the candidate channel
1118 --stable
1120 Install from the stable channel
1121 --cohort
1123 Switch the snap into the given cohort
1124 --leave-cohort
1126 Switch the snap out of its cohort
1127 tasks
1129 List a change's tasks
1130 The tasks command displays a summary of tasks associated with an indi‐
1132 vidual change.
1133 Usage: snap [OPTIONS] tasks [tasks-OPTIONS]
1135 Aliases: change
1138 --abs-time
1141 Display absolute times (in RFC 3339 format). Otherwise, display
1142 relative times up to 60 days, then YYYY-MM-DD.
1143 --last Select last change of given type (install, refresh, remove, try,
1145 auto-refresh, etc.). A question mark at the end of the type
1146 means to do nothing (instead of returning an error) if no change
1147 of the given type is found. Note the question mark could need
1148 protecting from the shell.
1149 try
1151 Test an unpacked snap in the system
1152 The try command installs an unpacked snap into the system for testing
1154 purposes. The unpacked snap content continues to be used even after
1155 installation, so non-metadata changes there go live instantly. Metadata
1156 changes such as those performed in snap.yaml will require reinstalla‐
1157 tion to go live.
1158 If snap-dir argument is omitted, the try command will attempt to infer
1160 it if either snapcraft.yaml file and prime directory or meta/snap.yaml
1161 file can be found relative to current working directory.
1162 Usage: snap [OPTIONS] try [try-OPTIONS]
1164 --no-wait
1166 Do not wait for the operation to finish but just print the
1167 change id.
1168 --devmode
1170 Put snap in development mode and disable security confinement
1171 --jailmode
1173 Put snap in enforced confinement mode
1174 --classic
1176 Put snap in classic mode and disable security confinement
1177 unalias
1179 Remove a manual alias, or the aliases for an entire snap
1180 The unalias command removes a single alias if the provided argument is
1182 a manual alias, or disables all aliases of a snap, including manual
1183 ones, if the argument is a snap name.
1184 Usage: snap [OPTIONS] unalias [unalias-OPTIONS]
1186 --no-wait
1188 Do not wait for the operation to finish but just print the
1189 change id.
1190 unset
1192 Remove configuration options
1193 The unset command removes the provided configuration options as
1195 requested.
1196 $ snap unset snap-name name address
1198 All configuration changes are persisted at once, and only after the
1200 snap's configuration hook returns successfully.
1201 Nested values may be removed via a dotted path:
1203 $ snap unset snap-name user.name
1205 Usage: snap [OPTIONS] unset [unset-OPTIONS]
1207 --no-wait
1209 Do not wait for the operation to finish but just print the
1210 change id.
1211 version
1213 Show version details
1214 The version command displays the versions of the running client,
1216 server, and operating system.
1217 wait
1219 Wait for configuration
1220 The wait command waits until a configuration becomes true.
1222 warnings
1224 List warnings
1225 The warnings command lists the warnings that have been reported to the
1227 system.
1228 Once warnings have been listed with 'snap warnings', 'snap okay' may be
1230 used to silence them. A warning that's been silenced in this way will
1231 not be listed again unless it happens again, _and_ a cooldown time has
1232 passed.
1233 Warnings expire automatically, and once expired they are forgotten.
1235 Usage: snap [OPTIONS] warnings [warnings-OPTIONS]
1237 --abs-time
1239 Display absolute times (in RFC 3339 format). Otherwise, display
1240 relative times up to 60 days, then YYYY-MM-DD.
1241 --unicode <default: "auto">
1243 Use a little bit of Unicode to improve legibility.
1244 --all Show all warnings
1246 --verbose
1248 Show more information
1249 watch
1251 Watch a change in progress
1252 The watch command waits for the given change-id to finish and shows
1254 progress (if available).
1255 Usage: snap [OPTIONS] watch [watch-OPTIONS]
1257 --last Select last change of given type (install, refresh, remove, try,
1259 auto-refresh, etc.). A question mark at the end of the type
1260 means to do nothing (instead of returning an error) if no change
1261 of the given type is found. Note the question mark could need
1262 protecting from the shell.
1263 whoami
1265 Show the email the user is logged in with
1266 The whoami command shows the email the user is logged in with.
1268 16 February 2021 snap(8)