|
13
|
1 .\" |
|
|
2 .\" Copyright (c) 2021 David Demelier <markand@malikania.fr> |
|
|
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 .\" |
|
|
16 .Dd June 30, 2021 |
|
|
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 .\" jobresult-add |
|
|
35 .Nm |
|
|
36 .Cm jobresult-add |
|
|
37 .Ar jobid |
|
|
38 .Ar worker |
|
|
39 .Ar exitcode |
|
|
40 .Ar console |
|
|
41 .\" project-add |
|
|
42 .Nm |
|
|
43 .Cm project-add |
|
|
44 .Ar name |
|
|
45 .Ar desc |
|
|
46 .Ar url |
|
|
47 .Ar script |
|
|
48 .\" project-info |
|
|
49 .Nm |
|
|
50 .Cm project-info |
|
|
51 .Ar name |
|
|
52 .\" project-list |
|
|
53 .Nm |
|
|
54 .Cm project-list |
|
|
55 .\" project-update |
|
|
56 .Nm |
|
|
57 .Cm project-update |
|
|
58 .Ar name |
|
|
59 .Ar key |
|
|
60 .Ar value |
|
|
61 .\" worker-add |
|
|
62 .Nm |
|
|
63 .Cm worker-add |
|
|
64 .Ar name |
|
|
65 .Ar desc |
|
|
66 .\" worker-list |
|
|
67 .Nm |
|
|
68 .Cm worker-list |
|
|
69 .\" DESCRIPTION |
|
|
70 .Sh DESCRIPTION |
|
|
71 The |
|
|
72 .Nm |
|
|
73 utility is a command line client that connects to |
|
|
74 .Xr scid 8 |
|
|
75 daemon. It is best used in conjunction with automated programs (such as cron) |
|
|
76 and SCM integration to add new jobs to execute. It is also used as |
|
|
77 administrative utility to create projects and workers. |
|
|
78 .Pp |
|
|
79 It is part of the |
|
|
80 .Xr sci 7 |
|
|
81 continuous integration framework. |
|
|
82 .Pp |
|
|
83 The following options are available |
|
|
84 .Em before |
|
|
85 the command name: |
|
|
86 .Bl -tag |
|
|
87 .It Fl s Ar path |
|
|
88 Connect to the UNIX local socket specified by |
|
|
89 .Ar path . |
|
|
90 .El |
|
|
91 .\" COMMANDS |
|
|
92 .Sh COMMANDS |
|
|
93 All commands are designed to return a human readable format but is guaranteed to |
|
|
94 stay compatible across new versions. It can be used in scripts as well. |
|
|
95 .Bl -tag -width project-update |
|
|
96 .\" job-add |
|
|
97 .It Cm job-add |
|
|
98 Create a new job for the given |
|
|
99 .Ar project |
|
|
100 using the user arbitrary |
|
|
101 .Ar tag |
|
|
102 identifier. |
|
|
103 .\" job-todo |
|
|
104 .It Cm job-todo |
|
|
105 List jobs that must be performed by the given |
|
|
106 .Ar worker . |
|
|
107 Jobs that were created earlier than the worker will not be listed to avoid |
|
|
108 evaluating a possible high number of jobs. |
|
|
109 .\" jobresult-add |
|
|
110 .It Cm jobresult-add |
|
|
111 Add a job result manually for the job id specified by |
|
|
112 .Ar jobid |
|
|
113 that was executed by the given |
|
|
114 .Ar worker |
|
|
115 The |
|
|
116 .Ar exitcode |
|
|
117 argument should be the project script exit status. The |
|
|
118 .Ar console |
|
|
119 argument should point to a file with the script's standard output and error. If |
|
|
120 specified to |
|
|
121 .Dq - |
|
|
122 the standard input is read instead. |
|
|
123 .\" project-add |
|
|
124 .It Cm project-add |
|
|
125 Create a new project with |
|
|
126 .Ar name , |
|
|
127 an user description set with |
|
|
128 .Ar desc , |
|
|
129 a website arbitrary |
|
|
130 .Ar url , |
|
|
131 and a script code to execute specified by file |
|
|
132 .Ar script . |
|
|
133 If the |
|
|
134 .Ar script |
|
|
135 argument is set to |
|
|
136 .Dq - |
|
|
137 the standard input is read instead. |
|
|
138 .\" project-info |
|
|
139 .It Cm project-info |
|
|
140 Get the detailed information, including the script code from |
|
|
141 .Ar project . |
|
|
142 .\" project-list |
|
|
143 .It Cm project-list |
|
|
144 List all projects, excluding the script code. |
|
|
145 .\" project-update |
|
|
146 .It Cm project-update |
|
|
147 Update an existing |
|
|
148 .Ar project |
|
|
149 by setting its new fields. The |
|
|
150 .Ar key |
|
|
151 argument should be one of the argument specified in the |
|
|
152 .Cm project-add |
|
|
153 command. For example, to update the description of a project one should |
|
|
154 specify |
|
|
155 .Dq desc |
|
|
156 as |
|
|
157 .Ar name |
|
|
158 argument and a new description as |
|
|
159 .Ar key . |
|
|
160 .Pp |
|
|
161 Example: |
|
|
162 .Bd -literal -offset indent |
|
|
163 scictl project-update example desc "New description" |
|
|
164 .Ed |
|
|
165 .\" worker-add |
|
|
166 .It Cm worker-add |
|
|
167 Create a new worker with |
|
|
168 .Ar name |
|
|
169 user identifier and an arbirary |
|
|
170 .Ar desc |
|
|
171 description. |
|
|
172 .\" worker-list |
|
|
173 .It Cm worker-list |
|
|
174 List all workers present on the system. It does not indicate if those workers |
|
|
175 are actually running. |
|
|
176 .El |
|
|
177 .\" SEE ALSO |
|
|
178 .Sh SEE ALSO |
|
|
179 .Xr sci 7 , |
|
|
180 .Xr scid 8 , |
|
|
181 .Xr sciwebd 8 , |
|
|
182 .Xr sciworkerd 8 |
