@itsbjoern/roost 0.1.7 → 0.1.9
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 +6 -6
- package/bin/roost +0 -0
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
1
|
## @itsbjoern/roost
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
CLI and JavaScript API for Roost (local HTTPS reverse proxy with automatic cert management). The package ships with platform-specific binaries (like [Biome](https://github.com/biomejs/biome)); after install you can run `roost` directly.
|
|
4
4
|
|
|
5
5
|
### Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
npm install -g @itsbjoern/roost
|
|
9
|
-
# or as a dependency:
|
|
10
|
-
npm install @itsbjoern/roost
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
### Usage
|
|
14
12
|
|
|
15
13
|
```bash
|
|
16
|
-
roost init
|
|
14
|
+
roost init # after global install
|
|
15
|
+
npx roost init # without installing (npm)
|
|
17
16
|
```
|
|
18
17
|
|
|
18
|
+
If `roost` is not found after a global install, add your package manager's global bin to `PATH` (e.g. `export PATH="$PATH:$(npm config get prefix)/bin"` for npm, or `export PATH="$PATH:$HOME/.bun/bin"` for Bun).
|
|
19
|
+
|
|
19
20
|
### JavaScript API
|
|
20
21
|
|
|
21
22
|
Use the package as a library to get cert/key **contents** (or paths) for HTTPS config. Use `getDomainCerts` for build tools—returns literal PEM strings, no file reads:
|
|
@@ -28,4 +29,3 @@ const { cert, key } = await getDomainCerts('api.local', { generate: true });
|
|
|
28
29
|
```
|
|
29
30
|
|
|
30
31
|
See the [main README](https://github.com/itsbjoern/roost#javascript-api) for full API docs and examples.
|
|
31
|
-
|
package/bin/roost
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itsbjoern/roost",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.9",
|
|
4
4
|
"description": "Roost CLI - local HTTPS reverse proxy with automatic cert management",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
7
7
|
"bin": {
|
|
8
8
|
"roost": "bin/roost"
|
|
9
9
|
},
|
|
10
|
+
"optionalDependencies": {
|
|
11
|
+
"@itsbjoern/roost-darwin-arm64": "0.1.9",
|
|
12
|
+
"@itsbjoern/roost-linux-x64": "0.1.9",
|
|
13
|
+
"@itsbjoern/roost-win32-x64": "0.1.9"
|
|
14
|
+
},
|
|
10
15
|
"scripts": {
|
|
11
16
|
"build": "tsc",
|
|
12
17
|
"postinstall": "node install.js",
|