This repository was archived by the owner on Jan 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstall.html
288 lines (286 loc) · 5.98 KB
/
install.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<!DOCTYPE html>
<html>
<head>
<title>Caltech Library's Digital Library Development Sandbox</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="index.html">README</a>
</li>
<li>
<a href="license.html">LICENSE</a>
</li>
<li>
<a href="install.html">INSTALL</a>
</li>
<li>
<a href="docs/">Documentation</a>
</li>
<li>
<a href="https://github.com/caltechlibrary/pkgassets">Github</a>
</li>
</ul>
</nav>
<section>
<h1 id="installation">
Installation
</h1>
<p>
<em>cligenerate</em> and <em>pkgassets</em> are a command line programs run from a shell like Bash. You can find compiled version in the <a href="https://github.com/caltechlibrary/cli/releases/latest">releases</a>.
</p>
<h2 id="compiled-version">
Compiled version
</h2>
<p>
This is generalized instructions for a release.
</p>
<p>
Compiled versions are available for Mac OS X (amd64 and M1 processor, macos-amd64 and macos-arm64), Linux (amd64 process, linux-amd64), Windows (amd64 processor, windows-amd64) and Rapsberry Pi (arm7 processor, raspbian-arm7)
</p>
<p>
VERSION_NUMBER is a <a href="http://semver.org/">symantic version number</a> (e.g. v0.1.2)
</p>
<p>
For all the released version go to the project page on Github and click latest release
</p>
<blockquote>
<p>
https://github.com/caltechlibrary/pkgassets/releases/latest
</p>
</blockquote>
<table>
<thead>
<tr class="header">
<th>
Platform
</th>
<th>
Zip Filename
</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>
Windows
</td>
<td>
cli-VERSION_NUMBER-windows-amd64.zip
</td>
</tr>
<tr class="even">
<td>
Mac OS X
</td>
<td>
cli-VERSION_NUMBER-macos-amd64.zip
</td>
</tr>
<tr class="odd">
<td>
Mac OS X
</td>
<td>
cli-VERSION_NUMBER-macos-arm64.zip
</td>
</tr>
<tr class="even">
<td>
Linux/Intel
</td>
<td>
cli-VERSION_NUMBER-linux-amd64.zip
</td>
</tr>
<tr class="odd">
<td>
Raspbery Pi
</td>
<td>
cli-VERSION_NUMBER-raspbian-arm7.zip
</td>
</tr>
</tbody>
</table>
<h2 id="the-basic-recipe">
The basic recipe
</h2>
<ul>
<li>
Find the Zip file listed matching the architecture you’re running and download it
<ul>
<li>
(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style CPU you’d choose the Zip file with “windows-amd64” in the name).
</li>
</ul>
</li>
<li>
Download the zip file and unzip the file.<br />
</li>
<li>
Copy the contents of the folder named “bin” to a folder that is in your path
<ul>
<li>
(e.g. “$HOME/bin” is common).
</li>
</ul>
</li>
<li>
Adjust your PATH if needed
<ul>
<li>
(e.g. export PATH=“<span class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)
</li>
</ul>
</li>
<li>
Test
</li>
</ul>
<h3 id="mac-os-x">
Mac OS X
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Make sure the new location in in our path
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in the Terminal App after downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip cli-*-macos-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
pkgassets -version</code></pre>
<h3 id="windows">
Windows
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip cli-*-windows-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
pkgassets -version</code></pre>
<h3 id="linux">
Linux
</h3>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell after downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip cli-*-linux-amd64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
pkgassets -version</code></pre>
<h3 id="raspberry-pi">
Raspberry Pi
</h3>
<p>
Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).
</p>
<ol type="1">
<li>
Download the zip file
</li>
<li>
Unzip the zip file
</li>
<li>
Copy the executables to $HOME/bin (or a folder in your path)
</li>
<li>
Test
</li>
</ol>
<p>
Here’s an example of the commands run in from the Bash shell after downloading the zip file.
</p>
<pre class="shell"><code> cd Downloads/
unzip cli-*-raspbian-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
pkgassets -version</code></pre>
<h2 id="compiling-from-source">
Compiling from source
</h2>
<p>
<em>cli</em> is “go get-able”. Use the “go get” command to download the dependant packages as well as <em>cli</em>’s source code.
</p>
<pre class="shell"><code> go get -u github.com/caltechlibrary/cli/...</code></pre>
<p>
Or clone the repstory and then compile
</p>
<pre class="shell"><code> cd
git clone https://github.com/caltechlibrary/cli src/github.com/caltechlibrary/cli
cd src/github.com/caltechlibrary/cli
make
make test
make install</code></pre>
</section>
<footer>
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span>
<span>© 2021 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
<span><a href="mailto:[email protected]">Email Us</a></span>
<a class="cl-hide" href="sitemap.xml">Site Map</a>
</footer>
</body>
</html>