1snap(8)                     System Manager's Manual                    snap(8)
2
3
4

NAME

6       snap - Tool to interact with snaps
7

SYNOPSIS

9       snap [OPTIONS]
10

DESCRIPTION

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

OPTIONS

COMMANDS

19   abort
20       Abort a pending change
21
22       The abort command attempts to abort a change  that  still  has  pending
23       tasks.
24
25       Usage: snap [OPTIONS] abort [abort-OPTIONS]
26
27       --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
33   ack
34       Add an assertion to the system
35
36       The ack command tries to add an assertion to the system assertion data‐
37       base.
38
39       The assertion may also be a newer revision of a pre-existing  assertion
40       that it will replace.
41
42       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
46   alias
47       Set up a manual alias
48
49       The  alias  command  aliases  the  given  snap application to the given
50       alias.
51
52       Once this manual alias is setup the respective application command  can
53       be invoked just using the alias.
54
55       Usage: snap [OPTIONS] alias [alias-OPTIONS]
56
57       --no-wait
58              Do  not  wait  for  the  operation  to finish but just print the
59              change id.
60
61   aliases
62       List aliases in the system
63
64       The aliases command lists all aliases available in the system and their
65       status.
66
67       $ snap aliases <snap>
68
69       Lists only the aliases defined by the specified snap.
70
71       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
76   changes
77       List system changes
78
79       The changes command displays a summary of system changes performed  re‐
80       cently.
81
82       Usage: snap [OPTIONS] changes [changes-OPTIONS]
83
84       --abs-time
85              Display  absolute times (in RFC 3339 format). Otherwise, display
86              relative times up to 60 days, then YYYY-MM-DD.
87
88   check-snapshot
89       Check a snapshot
90
91       The check-snapshot command verifies the user, system and  configuration
92       data of the snaps included in the specified snapshot.
93
94       The  check  operation runs the same data integrity verification that is
95       performed when a snapshot is restored.
96
97       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
101       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
105       Usage: snap [OPTIONS] check-snapshot [check-snapshot-OPTIONS]
106
107       --no-wait
108              Do not wait for the operation  to  finish  but  just  print  the
109              change id.
110
111       --users
112              Check  data  of  only specific users (comma-separated) (default:
113              all users)
114
115   connect
116       Connect a plug to a slot
117
118       The connect command connects a plug to a slot.  It may be called in the
119       following ways:
120
121       $ snap connect <snap>:<plug> <snap>:<slot>
122
123       Connects the provided plug to the given slot.
124
125       $ snap connect <snap>:<plug> <snap>
126
127       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
131       $ snap connect <snap>:<plug>
132
133       Connects  the  provided  plug  to the slot in the core snap with a name
134       matching the plug name.
135
136       Usage: snap [OPTIONS] connect [connect-OPTIONS]
137
138       --no-wait
139              Do not wait for the operation  to  finish  but  just  print  the
140              change id.
141
142   connections
143       List interface connections
144
145       The  connections  command  lists connections between plugs and slots in
146       the system.
147
148       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
152       $ snap connections <snap>
153
154       Lists connected and unconnected plugs and slots for the specified snap.
155
156       Usage: snap [OPTIONS] connections [connections-OPTIONS]
157
158       --all  Show connected and unconnected plugs and slots
159
160   create-cohort
161       Create cohort keys for a set of snaps
162
163       The create-cohort command creates a set of cohort keys for a given  set
164       of snaps.
165
166       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
174   debug
175       Run debug commands
176
177
178       The debug command contains a selection of additional sub-commands.
179
180       Debug  commands  can be removed without notice and may not work on non-
181       development systems.
182
183
184   debug confinement
185       Print the confinement mode the system operates in
186
187       The confinement command will print the confinement mode  (strict,  par‐
188       tial or none) the system operates in.
189
190   debug connectivity
191       Check network connectivity status
192
193       The connectivity command checks the network connectivity of snapd.
194
195   debug migrate-home
196       Migrate snaps' directory to ~/Snap.
197
198       Migrate snaps' directory to ~/Snap.
199
200       Usage: snap [OPTIONS] debug migrate-home [migrate-home-OPTIONS]
201
202       --no-wait
203
204   debug paths
205       Print system paths
206
207       The paths command prints the list of paths detected and used by snapd.
208
209   debug sandbox-features
210       Print sandbox features available on the system
211
212       The sandbox command prints tags describing features of individual sand‐
213       box components used by snapd on a given system.
214
215       Usage: snap [OPTIONS] debug sandbox-features [sandbox-features-OPTIONS]
216
217       --required
218              Ensure that given backend:feature is available
219
220   debug stacktraces
221       Obtain stacktraces of all snapd goroutines
222
223       Obtain stacktraces of all snapd goroutines.
224
225   debug state
226       Inspect a snapd state file.
227
228       Inspect a snapd state file, bypassing snapd API.
229
230       Usage: snap [OPTIONS] debug state [state-OPTIONS]
231
232       --abs-time
233              Display absolute times (in RFC 3339 format). Otherwise,  display
234              relative times up to 60 days, then YYYY-MM-DD.
235
236       --changes
237              List all changes
238
239       --task ID of the task to inspect
240
241       --change
242              ID of the change to inspect
243
244       --check
245              Check change consistency
246
247       --connections
248              List all connections
249
250       --connection
251              Show    details   of   the   matching   connections   (snap   or
252              snap:plug,snap:slot or snap:plug-or-slot
253
254       --is-seeded
255              Output seeding status (true or false)
256
257       --dot  Dot (graphviz) output
258
259       --no-hold
260              Omit tasks in 'Hold' state in the change output
261
262   debug timings
263       Get the timings of the tasks of a change
264
265       The timings command displays details about the time each task runs.
266
267       Usage: snap [OPTIONS] debug timings [timings-OPTIONS]
268
269       --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
275       --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
280       --all  Show timings for all executions of the given Ensure  or  startup
281              activity, not just the latest
282
283       --startup
284              Show  timings  for the startup of given subsystem (one of: load-
285              state, ifacemgr)
286
287       --verbose
288              Show more information
289
290   disable
291       Disable a snap in the system
292
293       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
297       Usage: snap [OPTIONS] disable [disable-OPTIONS]
298
299       --no-wait
300              Do not wait for the operation  to  finish  but  just  print  the
301              change id.
302
303   disconnect
304       Disconnect a plug from a slot
305
306       The  disconnect  command  disconnects  a  plug  from a slot.  It may be
307       called in the following ways:
308
309       $ snap disconnect <snap>:<plug> <snap>:<slot>
310
311       Disconnects the specific plug from the specific slot.
312
313       $ snap disconnect <snap>:<slot or plug>
314
315       Disconnects everything from the provided plug or slot.  The  snap  name
316       may be omitted for the core snap.
317
318       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
323       Usage: snap [OPTIONS] disconnect [disconnect-OPTIONS]
324
325       --no-wait
326              Do not wait for the operation  to  finish  but  just  print  the
327              change id.
328
329       --forget
330              Forget remembered state about the given connection.
331
332   download
333       Download the given snap
334
335       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
339       Usage: snap [OPTIONS] download [download-OPTIONS]
340
341       --channel
342              Use this channel instead of stable
343
344       --edge Install from the edge channel
345
346       --beta Install from the beta channel
347
348       --candidate
349              Install from the candidate channel
350
351       --stable
352              Install from the stable channel
353
354       --revision
355              Download  the  given  revision of a snap, to which you must have
356              developer access
357
358       --basename
359              Use this basename for the snap and assertion files (defaults  to
360              <snap>_<revision>)
361
362       --target-directory
363              Download to this directory (defaults to the current directory)
364
365       --cohort
366              Download from the given cohort
367
368   enable
369       Enable a snap in the system
370
371       The enable command enables a snap that was previously disabled.
372
373       Usage: snap [OPTIONS] enable [enable-OPTIONS]
374
375       --no-wait
376              Do  not  wait  for  the  operation  to finish but just print the
377              change id.
378
379   export-snapshot
380       Export a snapshot
381
382       Export a snapshot to the given filename.
383
384   find
385       Find packages to install
386
387       The find command queries the store for available packages.
388
389       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
394       A  green check mark (given color and unicode support) after a publisher
395       name indicates that the publisher has been verified.
396
397       Usage: snap [OPTIONS] find [find-OPTIONS]
398
399
400       Aliases: search
401
402
403       --private
404              Search private snaps.
405
406       --narrow
407              Only search for snaps in “stable”.
408
409       --section  [="show-all-sections-please"]  <default:  "no-section-speci‐
410       fied">
411              Restrict the search to a given section.
412
413       --color <default: "auto">
414              Use a little bit of color to highlight some things.
415
416       --unicode <default: "auto">
417              Use a little bit of Unicode to improve legibility.
418
419   forget
420       Delete a snapshot
421
422       The  forget  command  deletes a snapshot. This operation can not be un‐
423       done.
424
425       A snapshot contains archives for the  user,  system  and  configuration
426       data of each snap included in the snapshot.
427
428       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
431       Usage: snap [OPTIONS] forget [forget-OPTIONS]
432
433       --no-wait
434              Do not wait for the operation  to  finish  but  just  print  the
435              change id.
436
437   get
438       Print configuration options
439
440       The get command prints configuration options for the provided snap.
441
442           $ snap get snap-name username
443           frank
444
445       If multiple option names are provided, the corresponding values are re‐
446       turned:
447
448           $ snap get snap-name username password
449           Key       Value
450           username  frank
451           password  ...
452
453       Nested values may be retrieved via a dotted path:
454
455           $ snap get snap-name author.name
456           frank
457
458       Usage: snap [OPTIONS] get [get-OPTIONS]
459
460       -t     Strict typing with nulls and quoted strings
461
462       -d     Always return document, even with single key
463
464       -l     Always return list, even with single key
465
466   help
467       Show help about a command
468
469       The help command displays information about snap commands.
470
471       Usage: snap [OPTIONS] help [help-OPTIONS]
472
473       --all  Show a short summary of all commands
474
475   import-snapshot
476       Import a snapshot
477
478       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
481       Usage: snap [OPTIONS] import-snapshot [import-snapshot-OPTIONS]
482
483       --abs-time
484
485   info
486       Show detailed information about snaps
487
488       The info command shows detailed information about snaps.
489
490       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
496       Usage: snap [OPTIONS] info [info-OPTIONS]
497
498       --color <default: "auto">
499              Use a little bit of color to highlight some things.
500
501       --unicode <default: "auto">
502              Use a little bit of Unicode to improve legibility.
503
504       --abs-time
505              Display  absolute times (in RFC 3339 format). Otherwise, display
506              relative times up to 60 days, then YYYY-MM-DD.
507
508       --verbose
509              Include more details on the snap (expanded notes, base, etc.)
510
511   install
512       Install snaps on the system
513
514       The install command installs the named snaps on the system.
515
516       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
519       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
523       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
527       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
530       Use --name to set the instance name when installing from snap file.
531
532       Usage: snap [OPTIONS] install [install-OPTIONS]
533
534       --color <default: "auto">
535              Use a little bit of color to highlight some things.
536
537       --unicode <default: "auto">
538              Use a little bit of Unicode to improve legibility.
539
540       --no-wait
541              Do not wait for the operation  to  finish  but  just  print  the
542              change id.
543
544       --channel
545              Use this channel instead of stable
546
547       --edge Install from the edge channel
548
549       --beta Install from the beta channel
550
551       --candidate
552              Install from the candidate channel
553
554       --stable
555              Install from the stable channel
556
557       --devmode
558              Put snap in development mode and disable security confinement
559
560       --jailmode
561              Put snap in enforced confinement mode
562
563       --classic
564              Put snap in classic mode and disable security confinement
565
566       --revision
567              Install the given revision of a snap, to which you must have de‐
568              veloper access
569
570       --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
575       --unaliased
576              Install the given snap without enabling its automatic aliases
577
578       --name Install the snap file under the given instance name
579
580       --cohort
581              Install the snap in the given cohort
582
583       --ignore-validation
584              Ignore validation by other snaps blocking the installation
585
586       --transaction <default: "per-snap">
587              Have one transaction per-snap or one for all the specified snaps
588
589   interface
590       Show details of snap interfaces
591
592       The interface command shows details of snap interfaces.
593
594       If no interface name is provided, a list of  interface  names  with  at
595       least  one connection is shown, or a list of all interfaces if --all is
596       provided.
597
598       Usage: snap [OPTIONS] interface [interface-OPTIONS]
599
600       --attrs
601              Show interface attributes
602
603       --all  Include unused interfaces
604
605   known
606       Show known assertions of the provided type
607
608       The known command shows known assertions  of  the  provided  type.   If
609       header=value  pairs  are  provided after the assertion type, the asser‐
610       tions shown must also have the specified headers matching the  provided
611       values.
612
613       Usage: snap [OPTIONS] known [known-OPTIONS]
614
615       --remote
616              Query the store for the assertion, via snapd if possible
617
618       --direct
619              Query  the store for the assertion, without attempting to go via
620              snapd
621
622   list
623       List installed snaps
624
625       The list command displays a summary of snaps installed in  the  current
626       system.
627
628       A  green check mark (given color and unicode support) after a publisher
629       name indicates that the publisher has been verified.
630
631       Usage: snap [OPTIONS] list [list-OPTIONS]
632
633       --all  Show all revisions
634
635       --color <default: "auto">
636              Use a little bit of color to highlight some things.
637
638       --unicode <default: "auto">
639              Use a little bit of Unicode to improve legibility.
640
641   login
642       Authenticate to snapd and the store
643
644       The login command authenticates the user to snapd and the  snap  store,
645       and saves credentials into the ~/.snap/auth.json file. Further communi‐
646       cation with snapd will then be made using those credentials.
647
648       It's not necessary to log in to interact with snapd. Doing so, however,
649       enables  interactions without sudo, as well as some some developer-ori‐
650       ented features as detailed in the help for the find,  install  and  re‐
651       fresh commands.
652
653       An account can be set up at https://login.ubuntu.com
654
655   logout
656       Log out of snapd and the store
657
658       The logout command logs the current user out of snapd and the store.
659
660   logs
661       Retrieve logs for services
662
663       The  logs  command fetches logs of the given services and displays them
664       in chronological order.
665
666       Usage: snap [OPTIONS] logs [logs-OPTIONS]
667
668       --abs-time
669              Display absolute times (in RFC 3339 format). Otherwise,  display
670              relative times up to 60 days, then YYYY-MM-DD.
671
672       -n <default: "10">
673              Show only the given number of lines, or 'all'.
674
675       -f     Wait for new lines and print them as they come in.
676
677   model
678       Get the active model for this device
679
680       The  model  command  returns the active model assertion information for
681       this device.
682
683       By default, only the essential model identification information is  in‐
684       cluded in the output, but this can be expanded to include all of an as‐
685       sertion's non-meta headers.
686
687       The verbose output is presented in a structured, yaml-like format.
688
689       Similarly, the active serial assertion can be used for the  output  in‐
690       stead of the model assertion.
691
692       Usage: snap [OPTIONS] model [model-OPTIONS]
693
694       --abs-time
695              Display  absolute times (in RFC 3339 format). Otherwise, display
696              relative times up to 60 days, then YYYY-MM-DD.
697
698       --color <default: "auto">
699              Use a little bit of color to highlight some things.
700
701       --unicode <default: "auto">
702              Use a little bit of Unicode to improve legibility.
703
704       --serial
705              Print the serial assertion instead of the model assertion.
706
707       --verbose
708              Print all specific assertion fields.
709
710       --assertion
711              Print the raw assertion.
712
713   okay
714       Acknowledge warnings
715
716       The okay command acknowledges the warnings listed with 'snap warnings'.
717
718       Once acknowledged a warning won't appear again unless it re-occurrs and
719       sufficient time has passed.
720
721   pack
722       Pack the given directory as a snap
723
724       The  pack command packs the given snap-dir as a snap and writes the re‐
725       sult to target-dir. If target-dir is omitted, the result is written  to
726       current  directory.  If both source-dir and target-dir are omitted, the
727       pack command packs the current directory.
728
729       The default file name for a snap  can  be  derived  entirely  from  its
730       snap.yaml, but in some situations it's simpler for a script to feed the
731       filename in. In those cases, --filename can be given  to  override  the
732       default.  If this filename is not absolute it will be taken as relative
733       to target-dir.
734
735       When used with --check-skeleton, pack only checks whether snap-dir con‐
736       tains  valid  snap  metadata and raises an error otherwise. Application
737       commands listed in snap metadata file,  but  appearing  with  incorrect
738       permission  bits  result  in  an  error. Commands that are missing from
739       snap-dir are listed in diagnostic messages.
740
741       Usage: snap [OPTIONS] pack [pack-OPTIONS]
742
743       --check-skeleton
744              Validate snap-dir metadata only
745
746       --filename
747              Output to this filename
748
749       --compression
750              Compression to use (e.g. xz or lzo)
751
752   prefer
753       Enable aliases from a snap, disabling any conflicting aliases
754
755       The prefer command enables all aliases of the given snap in  preference
756       to  conflicting  aliases  of other snaps whose aliases will be disabled
757       (or removed, for manual ones).
758
759       Usage: snap [OPTIONS] prefer [prefer-OPTIONS]
760
761       --no-wait
762              Do not wait for the operation  to  finish  but  just  print  the
763              change id.
764
765   prepare-image
766       Prepare a device image
767
768       The prepare-image command performs some of the steps necessary for cre‐
769       ating device images.
770
771       For core images it is not invoked directly but usually  via  ubuntu-im‐
772       age.
773
774       For preparing classic images it supports a --classic mode
775
776       Usage: snap [OPTIONS] prepare-image [prepare-image-OPTIONS]
777
778       --classic
779              Enable classic mode to prepare a classic model image
780
781       --preseed
782              Preseed (UC20+ only)
783
784       --preseed-sign-key
785              Name  of the key to use to sign preseed assertion, otherwise use
786              the default key
787
788       --apparmor-features-dir
789              Optional path to apparmor kernel features directory (UC20+ only)
790
791       --arch Specify an architecture for snaps for --classic when  the  model
792              does not
793
794       --channel
795              The channel to use
796
797       --snap <snap>[=<channel>]
798              Include  the  given  snap  from the store or a local file and/or
799              specify the channel to track for the given snap
800
801   reboot
802       Reboot into selected system and mode
803
804       The reboot command reboots the system into a particular mode of the se‐
805       lected recovery system.
806
807       When  called  without  a  system  label and without a mode it will just
808       trigger a regular reboot.
809
810       When called without a system label but with a mode it will use the cur‐
811       rent system to enter the given mode.
812
813       Note that "recover", "factory-reset" and "run" modes are only available
814       for the current system.
815
816       Usage: snap [OPTIONS] reboot [reboot-OPTIONS]
817
818       --run  Boot into run mode
819
820       --install
821              Boot into install mode
822
823       --recover
824              Boot into recover mode
825
826       --factory-reset
827              Boot into factory-reset mode
828
829   recovery
830       List available recovery systems
831
832       The recovery command lists the available recovery systems.
833
834       With --show-keys it displays recovery keys that can be used  to  unlock
835       the  encrypted  partitions  if  the device-specific automatic unlocking
836       does not work.
837
838       Usage: snap [OPTIONS] recovery [recovery-OPTIONS]
839
840       --color <default: "auto">
841              Use a little bit of color to highlight some things.
842
843       --unicode <default: "auto">
844              Use a little bit of Unicode to improve legibility.
845
846       --show-keys
847              Show recovery keys (if available)  to  unlock  encrypted  parti‐
848              tions.
849
850   refresh
851       Refresh snaps in the system
852
853       The  refresh  command  updates the specified snaps, or all snaps in the
854       system if none are specified.
855
856       With no further options, the snaps are refreshed to the  current  revi‐
857       sion  of the channel they're tracking, preserving their confinement op‐
858       tions. All available channels of a snap are listed in its  'snap  info'
859       output.
860
861       Revision  choice  via the --revision override requires the user to have
862       developer access to the snap, either directly or  through  the  store's
863       collaboration feature, and to be logged in (see 'snap help login').
864
865       Note a later refresh will typically undo a revision override.
866
867       Usage: snap [OPTIONS] refresh [refresh-OPTIONS]
868
869       --color <default: "auto">
870              Use a little bit of color to highlight some things.
871
872       --unicode <default: "auto">
873              Use a little bit of Unicode to improve legibility.
874
875       --abs-time
876              Display  absolute times (in RFC 3339 format). Otherwise, display
877              relative times up to 60 days, then YYYY-MM-DD.
878
879       --no-wait
880              Do not wait for the operation  to  finish  but  just  print  the
881              change id.
882
883       --channel
884              Use this channel instead of stable
885
886       --edge Install from the edge channel
887
888       --beta Install from the beta channel
889
890       --candidate
891              Install from the candidate channel
892
893       --stable
894              Install from the stable channel
895
896       --devmode
897              Put snap in development mode and disable security confinement
898
899       --jailmode
900              Put snap in enforced confinement mode
901
902       --classic
903              Put snap in classic mode and disable security confinement
904
905       --amend
906              Allow refresh attempt on snap unknown to the store
907
908       --revision
909              Refresh  to the given revision, to which you must have developer
910              access
911
912       --cohort
913              Refresh the snap into the given cohort
914
915       --leave-cohort
916              Refresh the snap out of its cohort
917
918       --list Show the new versions of snaps that would be  updated  with  the
919              next refresh
920
921       --time Show auto refresh information but do not perform a refresh
922
923       --ignore-validation
924              Ignore validation by other snaps blocking the refresh
925
926       --transaction <default: "per-snap">
927              Have one transaction per-snap or one for all the specified snaps
928
929   remove
930       Remove snaps from the system
931
932       The remove command removes the named snap instance from the system.
933
934       By default all the snap revisions are removed, including their data and
935       the common data directory. When a --revision option is passed only  the
936       specified revision is removed.
937
938       Unless automatic snapshots are disabled, a snapshot of all data for the
939       snap is saved upon removal, which is then available for future restora‐
940       tion  with snap restore. The --purge option disables automatically cre‐
941       ating snapshots.
942
943       Usage: snap [OPTIONS] remove [remove-OPTIONS]
944
945       --no-wait
946              Do not wait for the operation  to  finish  but  just  print  the
947              change id.
948
949       --revision
950              Remove only the given revision
951
952       --purge
953              Remove the snap without saving a snapshot of its data
954
955   restart
956       Restart services
957
958       The restart command restarts the given services.
959
960       If  the  --reload  option  is  given,  for each service whose app has a
961       reload command, a reload is performed instead of a restart.
962
963       Usage: snap [OPTIONS] restart [restart-OPTIONS]
964
965       --no-wait
966              Do not wait for the operation  to  finish  but  just  print  the
967              change id.
968
969       --reload
970              If  the service has a reload command, use it instead of restart‐
971              ing.
972
973   restore
974       Restore a snapshot
975
976       The restore command replaces the current user, system and configuration
977       data  of included snaps, with the corresponding data from the specified
978       snapshot.
979
980       By default, this command restores all the data in a snapshot.  Alterna‐
981       tively,  you  can  specify  the  data of which snaps to restore, or for
982       which users, or a combination of these.
983
984       If a snap is included in a restore operation, excluding its system  and
985       configuration data from the restore is not currently possible. This re‐
986       striction may be lifted in the future.
987
988       Usage: snap [OPTIONS] restore [restore-OPTIONS]
989
990       --no-wait
991              Do not wait for the operation  to  finish  but  just  print  the
992              change id.
993
994       --users
995              Restore  data of only specific users (comma-separated) (default:
996              all users)
997
998   revert
999       Reverts the given snap to the previous state
1000
1001       The revert command reverts the given snap to its state before the  lat‐
1002       est  refresh. This will reactivate the previous snap revision, and will
1003       use the original data that was associated with that revision,  discard‐
1004       ing  any  data changes that were done by the latest revision. As an ex‐
1005       ception, data which the snap explicitly chooses to share  across  revi‐
1006       sions is not touched by the revert process.
1007
1008       Usage: snap [OPTIONS] revert [revert-OPTIONS]
1009
1010       --no-wait
1011              Do  not  wait  for  the  operation  to finish but just print the
1012              change id.
1013
1014       --devmode
1015              Put snap in development mode and disable security confinement
1016
1017       --jailmode
1018              Put snap in enforced confinement mode
1019
1020       --classic
1021              Put snap in classic mode and disable security confinement
1022
1023       --revision
1024              Revert to the given revision
1025
1026   run
1027       Run the given snap command
1028
1029       The run command executes the given snap command with the right confine‐
1030       ment and environment.
1031
1032       Usage:  snap  [OPTIONS]  run [run-OPTIONS] <NAME-OF-SNAP>.<NAME-OF-APP>
1033       [<SNAP-APP-ARG>...]
1034
1035       --shell
1036              Run a shell instead of the command (useful for debugging)
1037
1038       --debug-log
1039              Enable debug logging during early snap startup phases
1040
1041       --strace [="with-strace"] <default: "no-strace">
1042              Run the command  under  strace  (useful  for  debugging).  Extra
1043              strace  options  can  be  specified  as well here. Pass --raw to
1044              strace early snap helpers.
1045
1046       --gdbserver [=":0"] <default: "no-gdbserver">
1047              Run the command with gdbserver
1048
1049       --trace-exec
1050              Display exec calls timing data
1051
1052   save
1053       Save a snapshot of the current data
1054
1055       The save command creates a snapshot of the  current  user,  system  and
1056       configuration data for the given snaps.
1057
1058       By  default,  this  command  saves the data of all snaps for all users.
1059       Alternatively, you can specify the data of which snaps to save, or  for
1060       which users, or a combination of these.
1061
1062       If  a  snap  is  included in a save operation, excluding its system and
1063       configuration data from the snapshot is not  currently  possible.  This
1064       restriction may be lifted in the future.
1065
1066       Usage: snap [OPTIONS] save [save-OPTIONS]
1067
1068       --no-wait
1069              Do  not  wait  for  the  operation  to finish but just print the
1070              change id.
1071
1072       --abs-time
1073              Display absolute times (in RFC 3339 format). Otherwise,  display
1074              short relative times.
1075
1076       --users
1077              Snapshot data of only specific users (comma-separated) (default:
1078              all users)
1079
1080   saved
1081       List currently stored snapshots
1082
1083       The saved command displays a list of snapshots that have  been  created
1084       previously with the 'save' command.
1085
1086       Usage: snap [OPTIONS] saved [saved-OPTIONS]
1087
1088       --abs-time
1089              Display  absolute times (in RFC 3339 format). Otherwise, display
1090              short relative times.
1091
1092       --id   Show only a specific snapshot.
1093
1094   services
1095       Query the status of services
1096
1097       The services command lists information about the services specified, or
1098       about the services in all currently installed snaps.
1099
1100   set
1101       Change configuration options
1102
1103       The  set  command  changes  the  provided  configuration options as re‐
1104       quested.
1105
1106           $ snap set snap-name username=frank password=$PASSWORD
1107
1108       All configuration changes are persisted at once,  and  only  after  the
1109       snap's configuration hook returns successfully.
1110
1111       Nested values may be modified via a dotted path:
1112
1113           $ snap set snap-name author.name=frank
1114
1115       Configuration option may be unset with exclamation mark:
1116           $ snap set snap-name author!
1117
1118       Usage: snap [OPTIONS] set [set-OPTIONS]
1119
1120       --no-wait
1121              Do  not  wait  for  the  operation  to finish but just print the
1122              change id.
1123
1124       -t     Parse the value strictly as JSON document
1125
1126       -s     Parse the value as a string
1127
1128   start
1129       Start services
1130
1131       The start command starts, and optionally enables, the given services.
1132
1133       Usage: snap [OPTIONS] start [start-OPTIONS]
1134
1135       --no-wait
1136              Do not wait for the operation  to  finish  but  just  print  the
1137              change id.
1138
1139       --enable
1140              As  well  as  starting  the  service  now,  arrange for it to be
1141              started on boot.
1142
1143   stop
1144       Stop services
1145
1146       The stop command stops, and optionally disables, the given services.
1147
1148       Usage: snap [OPTIONS] stop [stop-OPTIONS]
1149
1150       --no-wait
1151              Do not wait for the operation  to  finish  but  just  print  the
1152              change id.
1153
1154       --disable
1155              As well as stopping the service now, arrange for it to no longer
1156              be started on boot.
1157
1158   switch
1159       Switches snap to a different channel
1160
1161       The switch command switches the given snap to a different channel with‐
1162       out doing a refresh. All available channels of a snap are listed in its
1163       'snap info' output.
1164
1165       Usage: snap [OPTIONS] switch [switch-OPTIONS]
1166
1167       --no-wait
1168              Do not wait for the operation  to  finish  but  just  print  the
1169              change id.
1170
1171       --channel
1172              Use this channel instead of stable
1173
1174       --edge Install from the edge channel
1175
1176       --beta Install from the beta channel
1177
1178       --candidate
1179              Install from the candidate channel
1180
1181       --stable
1182              Install from the stable channel
1183
1184       --cohort
1185              Switch the snap into the given cohort
1186
1187       --leave-cohort
1188              Switch the snap out of its cohort
1189
1190   tasks
1191       List a change's tasks
1192
1193       The  tasks command displays a summary of tasks associated with an indi‐
1194       vidual change.
1195
1196       Usage: snap [OPTIONS] tasks [tasks-OPTIONS]
1197
1198
1199       Aliases: change
1200
1201
1202       --abs-time
1203              Display absolute times (in RFC 3339 format). Otherwise,  display
1204              relative times up to 60 days, then YYYY-MM-DD.
1205
1206       --last Select last change of given type (install, refresh, remove, try,
1207              auto-refresh, etc.). A question mark at  the  end  of  the  type
1208              means to do nothing (instead of returning an error) if no change
1209              of the given type is found. Note the question  mark  could  need
1210              protecting from the shell.
1211
1212   try
1213       Test an unpacked snap in the system
1214
1215       The  try  command installs an unpacked snap into the system for testing
1216       purposes.  The unpacked snap content continues to be  used  even  after
1217       installation, so non-metadata changes there go live instantly. Metadata
1218       changes such as those performed in snap.yaml will  require  reinstalla‐
1219       tion to go live.
1220
1221       If  snap-dir argument is omitted, the try command will attempt to infer
1222       it if either snapcraft.yaml file and prime directory or  meta/snap.yaml
1223       file can be found relative to current working directory.
1224
1225       Usage: snap [OPTIONS] try [try-OPTIONS]
1226
1227       --no-wait
1228              Do  not  wait  for  the  operation  to finish but just print the
1229              change id.
1230
1231       --devmode
1232              Put snap in development mode and disable security confinement
1233
1234       --jailmode
1235              Put snap in enforced confinement mode
1236
1237       --classic
1238              Put snap in classic mode and disable security confinement
1239
1240   unalias
1241       Remove a manual alias, or the aliases for an entire snap
1242
1243       The unalias command removes a single alias if the provided argument  is
1244       a  manual  alias,  or  disables all aliases of a snap, including manual
1245       ones, if the argument is a snap name.
1246
1247       Usage: snap [OPTIONS] unalias [unalias-OPTIONS]
1248
1249       --no-wait
1250              Do not wait for the operation  to  finish  but  just  print  the
1251              change id.
1252
1253   unset
1254       Remove configuration options
1255
1256       The  unset  command  removes  the provided configuration options as re‐
1257       quested.
1258
1259            $ snap unset snap-name name address
1260
1261       All configuration changes are persisted at once,  and  only  after  the
1262       snap's configuration hook returns successfully.
1263
1264       Nested values may be removed via a dotted path:
1265
1266            $ snap unset snap-name user.name
1267
1268       Usage: snap [OPTIONS] unset [unset-OPTIONS]
1269
1270       --no-wait
1271              Do  not  wait  for  the  operation  to finish but just print the
1272              change id.
1273
1274   version
1275       Show version details
1276
1277       The version command  displays  the  versions  of  the  running  client,
1278       server, and operating system.
1279
1280   wait
1281       Wait for configuration
1282
1283       The wait command waits until a configuration becomes true.
1284
1285   warnings
1286       List warnings
1287
1288       The  warnings command lists the warnings that have been reported to the
1289       system.
1290
1291       Once warnings have been listed with 'snap warnings', 'snap okay' may be
1292       used  to  silence them. A warning that's been silenced in this way will
1293       not be listed again unless it happens again, _and_ a cooldown time  has
1294       passed.
1295
1296       Warnings expire automatically, and once expired they are forgotten.
1297
1298       Usage: snap [OPTIONS] warnings [warnings-OPTIONS]
1299
1300       --abs-time
1301              Display  absolute times (in RFC 3339 format). Otherwise, display
1302              relative times up to 60 days, then YYYY-MM-DD.
1303
1304       --unicode <default: "auto">
1305              Use a little bit of Unicode to improve legibility.
1306
1307       --all  Show all warnings
1308
1309       --verbose
1310              Show more information
1311
1312   watch
1313       Watch a change in progress
1314
1315       The watch command waits for the given change-id  to  finish  and  shows
1316       progress (if available).
1317
1318       Usage: snap [OPTIONS] watch [watch-OPTIONS]
1319
1320       --last Select last change of given type (install, refresh, remove, try,
1321              auto-refresh, etc.). A question mark at  the  end  of  the  type
1322              means to do nothing (instead of returning an error) if no change
1323              of the given type is found. Note the question  mark  could  need
1324              protecting from the shell.
1325
1326   whoami
1327       Show the email the user is logged in with
1328
1329       The whoami command shows the email the user is logged in with.
1330
1331

NOTES

1333        1. Online documentation
1334           https://docs.snapcraft.io
1335

BUGS

1337       Please report all bugs with https://bugs.launchpad.net/snapd/+filebug
1338
1339
1340
1341                               16 December 2022                        snap(8)
Impressum