Mercurial > sci
annotate man/scictl.8 @ 61:8be8188d61a5
scictl: resurrect project-update command
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 18 Aug 2022 10:42:42 +0200 |
parents | b474f0985e39 |
children | 562372396019 |
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 | |
72 It is part of the | |
73 .Xr sci 7 | |
74 continuous integration framework. | |
75 .\" COMMANDS | |
76 .Sh COMMANDS | |
77 All commands are designed to return a human readable format but is guaranteed to | |
78 stay compatible across new versions. It can be used in scripts as well. | |
79 .Bl -tag -width project-update | |
80 .\" job-add | |
81 .It Cm job-add | |
82 Create a new job for the given | |
83 .Ar project | |
84 using the user arbitrary | |
85 .Ar tag | |
86 identifier. | |
87 .\" job-todo | |
88 .It Cm job-todo | |
89 List jobs that must be performed by the given | |
90 .Ar worker . | |
91 Jobs that were created earlier than the worker will not be listed to avoid | |
92 evaluating a possible high number of jobs. | |
93 .\" project-add | |
94 .It Cm project-add | |
95 Create a new project with | |
96 .Ar name , | |
97 an user description set with | |
98 .Ar desc , | |
99 a website arbitrary | |
100 .Ar url , | |
101 and a script code to execute specified by file | |
102 .Ar script . | |
103 If the | |
104 .Ar script | |
105 argument is set to | |
106 .Dq - | |
107 the standard input is read instead. | |
108 .\" project-info | |
109 .It Cm project-info | |
110 Get the detailed information, including the script code from | |
111 .Ar project . | |
112 .\" project-list | |
113 .It Cm project-list | |
114 List all projects, excluding the script code. | |
115 .\" project-update | |
116 .It Cm project-update | |
117 Update an existing | |
118 .Ar project | |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
119 by setting its new fields. |
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
120 .Pp |
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
121 The |
13 | 122 .Ar key |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
123 argument should be one of the argument name is similar to the |
13 | 124 .Cm project-add |
125 command. For example, to update the description of a project one should | |
126 specify | |
127 .Dq desc | |
128 as | |
129 .Ar name | |
130 argument and a new description as | |
131 .Ar key . | |
132 .Pp | |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
133 Examples: |
13 | 134 .Bd -literal -offset indent |
135 scictl project-update example desc "New description" | |
61
8be8188d61a5
scictl: resurrect project-update command
David Demelier <markand@malikania.fr>
parents:
50
diff
changeset
|
136 scictl project-update example script "/path/to/script.sh" |
13 | 137 .Ed |
138 .\" worker-add | |
139 .It Cm worker-add | |
140 Create a new worker with | |
141 .Ar name | |
142 user identifier and an arbirary | |
143 .Ar desc | |
144 description. | |
145 .\" worker-list | |
146 .It Cm worker-list | |
147 List all workers present on the system. It does not indicate if those workers | |
148 are actually running. | |
149 .El | |
50
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
150 .\" ENVIRONMENT |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
151 .Sh ENVIRONMENT |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
152 The following environment variables affects |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
153 .Nm : |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
154 .Bl -tag |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
155 .It Ev SCI_API_URL |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
156 Points to a HTTP URL where |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
157 .Nm scid |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
158 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
|
159 .Dq http |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
160 or |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
161 .Dq https . |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
162 .It Ev SCI_API_KEY |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
163 Secret API key to perform requests. |
b474f0985e39
scictl: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
164 .El |
13 | 165 .\" SEE ALSO |
166 .Sh SEE ALSO | |
167 .Xr sci 7 , | |
168 .Xr scid 8 , | |
169 .Xr sciworkerd 8 |