Mercurial > sci
annotate man/scictl.8 @ 74:38bdcfb3d4f7
themes: fix worker page
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 24 Jan 2023 11:30:32 +0100 |
parents | 5076be758687 |
children | 71cd8447e3a4 |
rev | line source |
---|---|
13 | 1 .\" |
32
081e1c258e64
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
2 .\" Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> |
13 | 3 .\" |
4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
5 .\" purpose with or without fee is hereby granted, provided that the above | |
6 .\" copyright notice and this permission notice appear in all copies. | |
7 .\" | |
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
15 .\" | |
32
081e1c258e64
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
16 .Dd June 30, 2021-2022 |
13 | 17 .Dt SCICTL 8 |
18 .Os | |
19 .\" NAME | |
20 .Sh NAME | |
21 .Nm scictl | |
22 .Nd command line client to scid | |
23 .\" SYNOPSIS | |
24 .Sh SYNOPSIS | |
25 .\" job-add | |
26 .Nm | |
27 .Cm job-add | |
28 .Ar project | |
29 .Ar tag | |
30 .\" job-todo | |
31 .Nm | |
32 .Cm job-todo | |
33 .Ar worker | |
34 .\" project-add | |
35 .Nm | |
36 .Cm project-add | |
37 .Ar name | |
38 .Ar desc | |
39 .Ar url | |
40 .Ar script | |
41 .\" project-info | |
42 .Nm | |
43 .Cm project-info | |
44 .Ar name | |
45 .\" project-list | |
46 .Nm | |
47 .Cm project-list | |
48 .\" project-update | |
49 .Nm | |
50 .Cm project-update | |
51 .Ar name | |
52 .Ar key | |
53 .Ar value | |
54 .\" worker-add | |
55 .Nm | |
56 .Cm worker-add | |
57 .Ar name | |
58 .Ar desc | |
59 .\" worker-list | |
60 .Nm | |
61 .Cm worker-list | |
62 .\" DESCRIPTION | |
63 .Sh DESCRIPTION | |
64 The | |
65 .Nm | |
66 utility is a command line client that connects to | |
67 .Xr scid 8 | |
68 daemon. It is best used in conjunction with automated programs (such as cron) | |
69 and SCM integration to add new jobs to execute. It is also used as | |
70 administrative utility to create projects and workers. | |
71 .Pp | |
64
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
72 The following options are available |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
73 .Em before |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
74 the command name: |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
75 .Bl -tag |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
76 .It Fl k Ar key |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
77 Set the API authentication to |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
78 .Ar key . |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
79 .It Fl u |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
80 Set the |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
81 .Ar url |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
82 for connecting to |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
83 .Xr scid 8 . |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
84 You can specify a scheme using |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
85 .Dq http:// |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
86 or |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
87 .Dq https:// . |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
88 Default: |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
89 .Dq localhost . |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
90 .El |
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
61
diff
changeset
|
91 .Pp |
13 | 92 It is part of the |
93 .Xr sci 7 | |
94 continuous integration framework. | |
95 .\" COMMANDS | |
96 .Sh COMMANDS | |
97 All commands are designed to return a human readable format but is guaranteed to | |
98 stay compatible across new versions. It can be used in scripts as well. | |
99 .Bl -tag -width project-update | |
100 .\" job-add | |
101 .It Cm job-add | |
102 Create a new job for the given | |
103 .Ar project | |
104 using the user arbitrary | |
105 .Ar tag | |
106 identifier. | |
107 .\" job-todo | |
108 .It Cm job-todo | |
109 List jobs that must be performed by the given | |
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
110 .Ar worker |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
111 name. Jobs that were created earlier than the worker will not be listed to |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
112 avoid evaluating a possible high number of jobs. |
13 | 113 .\" project-add |
114 .It Cm project-add | |
115 Create a new project with | |
116 .Ar name , | |
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
117 a user description set with |
13 | 118 .Ar desc , |
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
119 an arbitrary website |
13 | 120 .Ar url , |
121 and a script code to execute specified by file | |
122 .Ar script . | |
123 If the | |
124 .Ar script | |
125 argument is set to | |
126 .Dq - | |
127 the standard input is read instead. | |
128 .\" project-info | |
129 .It Cm project-info | |
130 Get the detailed information, including the script code from | |
131 .Ar project . | |
132 .\" project-list | |
133 .It Cm project-list | |
134 List all projects, excluding the script code. | |
135 .\" project-update | |
136 .It Cm project-update | |
137 Update an existing | |
138 .Ar project | |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
139 by setting its new fields. |
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
140 .Pp |
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
141 The |
13 | 142 .Ar key |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
143 argument should be one of the argument name is similar to the |
13 | 144 .Cm project-add |
145 command. For example, to update the description of a project one should | |
146 specify | |
147 .Dq desc | |
148 as | |
149 .Ar name | |
150 argument and a new description as | |
151 .Ar key . | |
152 .\" worker-add | |
153 .It Cm worker-add | |
154 Create a new worker with | |
155 .Ar name | |
156 user identifier and an arbirary | |
157 .Ar desc | |
158 description. | |
159 .\" worker-list | |
160 .It Cm worker-list | |
161 List all workers present on the system. It does not indicate if those workers | |
162 are actually running. | |
163 .El | |
50
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
164 .\" ENVIRONMENT |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
165 .Sh ENVIRONMENT |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
166 The following environment variables affects |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
167 .Nm : |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
168 .Bl -tag |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
169 .It Ev SCI_API_URL |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
170 Points to a HTTP URL where |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
171 .Nm scid |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
172 is running. Must start with a HTTP scheme such as |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
173 .Dq http |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
174 or |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
175 .Dq https . |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
176 .It Ev SCI_API_KEY |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
177 Secret API key to perform requests. |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
178 .El |
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
179 .\" EXAMPLES |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
180 .Sh EXAMPLES |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
181 Add a new worker named OpenBSD with identifier openbsd |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
182 .Bd -literal -offset indent |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
183 $ scictl worker-add openbsd OpenBSD |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
184 .Ed |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
185 .Pp |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
186 Add a project hello that executes a script shell. |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
187 .Bd -literal -offset indent |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
188 $ scictl project add hello "Hello World" http://hello.org hello.sh |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
189 .Ed |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
190 .Pp |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
191 Add a new job for the project hello with as argument |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
192 .Dq world |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
193 .Bd -literal -offset indent |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
194 $ scictl job-add hello world |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
195 .Ed |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
196 .Pp |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
197 Update the project hello with new description and new code |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
198 .Bd -literal -offset indent |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
199 scictl project-update example desc "Hello World v2"" |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
200 scictl project-update example script hello2.sh |
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
201 .Ed |
13 | 202 .\" SEE ALSO |
203 .Sh SEE ALSO | |
204 .Xr sci 7 , | |
205 .Xr scid 8 , | |
206 .Xr sciworkerd 8 |