@faable/faable 4.33.0 → 4.34.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 CHANGED
@@ -1,28 +1,39 @@
1
1
  <p align="center">
2
- <a href="https://faable.com">
3
- <img src="https://www.faable.com/assets/logo/Emblem.png" height="96">
4
- <h3 align="center">Faable</h3>
2
+ <a href="https://faable.com/docs/cli">
3
+ <img src="https://raw.githubusercontent.com/faablecloud/faable/main/.github/assets/cover.png" alt="Faable CLI: deploy and run your apps from the terminal" width="100%">
5
4
  </a>
6
5
  </p>
7
6
 
8
7
  <p align="center">
9
- Your React, Node.js or Python apps, up to the cloud in seconds.
8
+ <a href="https://www.npmjs.com/package/@faable/faable"><img alt="npm version" src="https://img.shields.io/npm/v/@faable/faable.svg?labelColor=121a29&color=7270ee"></a>
9
+ <a href="LICENSE"><img alt="MIT license" src="https://img.shields.io/badge/license-MIT-7270ee?labelColor=121a29"></a>
10
+ <a href="https://faable.com/docs/cli"><img alt="Documentation" src="https://img.shields.io/badge/docs-faable.com-7270ee?labelColor=121a29"></a>
10
11
  </p>
11
12
 
12
- ## Faable CLI
13
+ # Faable CLI
13
14
 
14
- `@faable/faable` is the command-line interface for the Faable platform. It covers
15
- **Faable Deploy** (ship and operate apps) and **Faable Auth** (manage an identity
16
- tenant: users, login-flow actions, OAuth clients and the audit log) from one binary.
15
+ `@faable/faable` is the command-line interface for the [Faable](https://faable.com) platform. It
16
+ covers **Faable Deploy** (ship and operate apps) and **Faable Auth** (manage an identity tenant:
17
+ users, login-flow actions, OAuth clients and the audit log) from one binary.
17
18
 
18
19
  Full reference: **[faable.com/docs/cli](https://faable.com/docs/cli)**.
19
20
 
20
- To install the latest version:
21
+ ## Install
22
+
23
+ Requires Node.js 22.8 or later.
21
24
 
22
25
  ```bash
23
26
  npm i -g @faable/faable
24
27
  ```
25
28
 
29
+ ## Quick start
30
+
31
+ ```bash
32
+ faable login # sign in from your browser
33
+ faable deploy # deploy the current directory
34
+ faable deploy status
35
+ ```
36
+
26
37
  ## Commands
27
38
 
28
39
  | Group | What it does | Docs |
@@ -156,3 +167,17 @@ the public docs, not here.
156
167
  - [Login flows](https://faable.com/docs/auth/login-flows) and [actions](https://faable.com/docs/auth/extensibility/actions) — the hooks managed by `auth actions`
157
168
  - [Logs](https://faable.com/docs/auth/logs) — the audit trail read by `auth logs`
158
169
  - [OAuth 2.0 flows](https://faable.com/docs/auth/oauth-flows) · [OpenID Connect](https://faable.com/docs/auth/oidc) · [Validate access tokens](https://faable.com/docs/auth/validate-access-tokens)
170
+
171
+ ## Support
172
+
173
+ - **Documentation:** [faable.com/docs](https://faable.com/docs)
174
+ - **Community help, on every plan:** [GitHub Discussions](https://github.com/orgs/faablecloud/discussions)
175
+ - **Help from the Faable team, on the Hobby and Pro plans:** [support@faable.com](mailto:support@faable.com).
176
+ See the [support page](https://faable.com/docs/platform/support)
177
+ - **Bugs and feature requests:** [open an issue](https://github.com/faablecloud/faable/issues)
178
+ - **Security issues:** report them privately to [support@faable.com](mailto:support@faable.com),
179
+ not in a public issue
180
+
181
+ ## License
182
+
183
+ [MIT](LICENSE) © Faable Cloud SLU
@@ -36,6 +36,9 @@ class Configuration {
36
36
  get configuredStartCommand() {
37
37
  return this.config.startCommand;
38
38
  }
39
+ get installCommand() {
40
+ return this.config.installCommand;
41
+ }
39
42
  get buildCommand() {
40
43
  return this.config.buildCommand;
41
44
  }
@@ -46,6 +49,7 @@ class Configuration {
46
49
  deployConfig() {
47
50
  return {
48
51
  startCommand: this.config.startCommand,
52
+ installCommand: this.config.installCommand,
49
53
  buildCommand: this.config.buildCommand,
50
54
  buildpack: this.config.buildpack,
51
55
  rootDir: this.config.rootDir,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/faable",
3
- "version": "4.33.0",
3
+ "version": "4.34.0",
4
4
  "main": "dist/index.js",
5
5
  "license": "MIT",
6
6
  "author": "Marc Pomar <marc@faable.com>",
@@ -20,7 +20,7 @@
20
20
  "registry": "https://registry.npmjs.org/",
21
21
  "access": "public"
22
22
  },
23
- "homepage": "https://github.com/faablecloud/faable#readme",
23
+ "homepage": "https://faable.com/docs/cli",
24
24
  "files": [
25
25
  "dist",
26
26
  "bin"