@harly/cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/dist/index.js +2 -0
- package/package.json +23 -0
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://cdn.molret.dev/banner-harly.webp" alt="Harly — self-hosted applicant tracking system" width="1200" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
The shortest way to install, operate, and upgrade a self-hosted Harly deployment.
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
# @harly/cli
|
|
10
|
+
|
|
11
|
+
Official operations command for Harly self-hosting. It delegates to the
|
|
12
|
+
versioned `@harly/create` package:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx @harly/cli init harly
|
|
16
|
+
cd harly
|
|
17
|
+
npx @harly/cli upgrade
|
|
18
|
+
npx @harly/cli doctor
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Upgrades preserve configuration and Docker volumes, create a backup first,
|
|
22
|
+
run migrations once, wait for health checks, and pin the pulled image digest.
|
|
23
|
+
|
|
24
|
+
## Requirements
|
|
25
|
+
|
|
26
|
+
- Node.js 20.12 or newer
|
|
27
|
+
- Docker Engine 24 or newer
|
|
28
|
+
- Docker Compose 2.20 or newer
|
|
29
|
+
- A Linux VPS with 2 GB RAM plus swap minimum; 4 GB recommended
|
|
30
|
+
|
|
31
|
+
## Install Harly
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx @harly/cli init harly
|
|
35
|
+
cd harly
|
|
36
|
+
npx @harly/cli launch . --yes
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The wizard configures PostgreSQL, the Harly app, scheduler, persistent uploads,
|
|
40
|
+
and optional automatic HTTPS through Caddy.
|
|
41
|
+
|
|
42
|
+
## Upgrade safely
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
cd harly
|
|
46
|
+
npx @harly/cli upgrade
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Use `--to edge` for preview builds or `--to <version>` for a fixed release.
|
|
50
|
+
Encrypted backups use `AGE_RECIPIENT`; plaintext backups require the explicit
|
|
51
|
+
`--allow-plaintext` flag.
|
|
52
|
+
|
|
53
|
+
## Commands
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
harly init [directory]
|
|
57
|
+
harly launch [directory] [--yes]
|
|
58
|
+
harly doctor [directory] [--json]
|
|
59
|
+
harly backup [directory]
|
|
60
|
+
harly restore <archive> [directory] --force
|
|
61
|
+
harly upgrade [directory] [--to version|edge]
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Harly is open source under AGPL-3.0. Source, documentation, and issue tracking
|
|
65
|
+
live at [github.com/Vytral/harly](https://github.com/Vytral/harly).
|
package/dist/index.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@harly/cli",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"type": "module",
|
|
6
|
+
"description": "Official operations CLI for self-hosted Harly.",
|
|
7
|
+
"license": "AGPL-3.0-only",
|
|
8
|
+
"keywords": ["harly", "ats", "recruiting", "self-hosted", "docker"],
|
|
9
|
+
"homepage": "https://github.com/Vytral/harly#readme",
|
|
10
|
+
"repository": { "type": "git", "url": "git+https://github.com/Vytral/harly.git", "directory": "tooling/harly" },
|
|
11
|
+
"bugs": { "url": "https://github.com/Vytral/harly/issues" },
|
|
12
|
+
"engines": { "node": ">=20.12.0" },
|
|
13
|
+
"publishConfig": { "access": "public" },
|
|
14
|
+
"files": ["dist", "README.md"],
|
|
15
|
+
"bin": { "harly": "dist/index.js" },
|
|
16
|
+
"scripts": {
|
|
17
|
+
"build": "node scripts/build.mjs",
|
|
18
|
+
"typecheck": "node --check dist/index.js",
|
|
19
|
+
"test": "node --test test/*.test.mjs",
|
|
20
|
+
"pack:check": "npm pack --dry-run"
|
|
21
|
+
},
|
|
22
|
+
"dependencies": { "@harly/create": "0.1.0" }
|
|
23
|
+
}
|