1ctr(1)                      General Commands Manual                     ctr(1)
2
3
4

SYNOPSIS

6       ctr [global options] command [command options] [arguments...]
7
8

DESCRIPTION

10       ctr  is  an unsupported debug and administrative client for interacting
11       with the containerd daemon. Because it is  unsupported,  the  commands,
12       options,  and operation are not guaranteed to be backward compatible or
13       stable from release to release of the containerd project.
14
15

OPTIONS

17       The following commands are available in the ctr utility:
18
19
20       plugins,plugin : Provides information about containerd plugins
21
22
23       version : Prints the client and server versions
24
25
26       containers,c,container : Manages and interacts with containers
27
28
29       content : Manages and interacts with content
30
31
32       events,event : Displays containerd events
33
34
35       images,image : Manages and interacts with images
36
37
38       namespaces,namespace : Manages and interacts with containerd namespaces
39
40
41       pprof : Provides golang pprof outputs for containerd
42
43
44       run : Runs a container
45
46
47       snapshots,snapshot : Manages and interacts with snapshots
48
49
50       tasks,t,task : Manages and interacts with tasks
51
52
53       shim : Interacts with a containerd shim directly
54
55
56       help,h : Displays a list of commands or help for one specific command
57
58
59       The following global options apply to all ctr commands:
60
61
62       --debug : Enable debug output in logs
63
64
65       --address value, -a  value  :  Address  for  containerd's  GRPC  server
66       (default: /run/containerd/containerd.sock)
67
68
69       --timeout value : Total timeout for ctr commands (default: 0s)
70
71
72       --connect-timeout   value   :  Timeout  for  connecting  to  containerd
73       (default: 0s)
74
75
76       --namespace value, -n value : Namespace to use with commands  (default:
77       default) [also read from $CONTAINERD_NAMESPACE]
78
79
80       --help, -h : Show help text
81
82
83       --version, -v : Prints the ctr version
84
85

BUGS

87       Note  that  the  ctr utility is not an officially supported part of the
88       containerd project releases.
89
90
91       However, please  feel  free  to  file  any  specific  issues  that  you
92       encounter at
93
94       ⟨https://github.com/containerd/containerd⟩.
95
96

AUTHOR

98       Phil Estes ⟨estesp@gmail.com⟩
99
100

SEE ALSO

102       containerd(1), containerd-config(1), containerd-config.toml(5)
103
104
105
106                                  01/30/2018                            ctr(1)
Impressum