ignitify 1.0.0 → 1.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.
Files changed (4) hide show
  1. package/README.md +118 -0
  2. package/ignitify-NOTICE.txt +1 -1
  3. package/ignitify.cjs +8679 -323
  4. package/package.json +14 -2
package/README.md ADDED
@@ -0,0 +1,118 @@
1
+ # ignitify
2
+
3
+ The command line tool for the [Ignitify](https://ignitify.dev) service: create, deploy and run tasks.
4
+
5
+ ## Install
6
+
7
+ You need Node.js 22.13 or newer.
8
+
9
+ ```sh
10
+ npm install --global ignitify
11
+ ignitify --version
12
+ ```
13
+
14
+ In CI, or for one command, pin the version:
15
+
16
+ ```sh
17
+ npx ignitify@1.1.0 whoami
18
+ ```
19
+
20
+ If the install fails with `EACCES`, do not use `sudo`. Install Node.js with a version manager, as the npm guide tells you: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally
21
+
22
+ ## Quick start
23
+
24
+ ```sh
25
+ ignitify login # sign this machine in
26
+ ignitify whoami # show your account, limits and usage
27
+ ignitify task:create hello # register a task and write its files
28
+ ignitify task:deploy hello # build it on the platform
29
+ ignitify task:run hello --wait # run it and print the result
30
+ ```
31
+
32
+ ## Commands
33
+
34
+ Every command is `<resource>:<verb>`. Run `ignitify help` for the list, and `ignitify <command> --help` for the flags of one command. The full reference is at https://ignitify.dev/docs/cli (all commands in one table: https://ignitify.dev/docs/cli/all).
35
+
36
+ | Group | Commands |
37
+ | :-- | :-- |
38
+ | Tasks | `task:create`, `task:list`, `task:get`, `task:delete`, `task:validate`, `task:pack`, `task:deploy`, `task:run` |
39
+ | Deployments | `deployment:list`, `deployment:get`, `deployment:logs`, `deployment:delete` |
40
+ | Runs | `run:list`, `run:get`, `run:logs`, `run:delete`, `run:cancel` |
41
+ | VMs | `vm:list`, `vm:get`, `vm:delete` |
42
+ | Secrets | `secret:set`, `secret:list`, `secret:delete` |
43
+ | Schedules | `schedule:list`, `schedule:cancel` |
44
+ | Webhooks | `hook:create`, `hook:list`, `hook:delete`, `notify:set` |
45
+ | Account and usage | `login`, `logout`, `whoami`, `quota`, `usage`, `usage:export`, `help` |
46
+
47
+ Global flags: `--json` (one JSON document on stdout), `-h, --help`, `-v, --version`. The delete and cancel commands also take `-y, --yes` (answer yes to the question, for scripts).
48
+
49
+ ## Configuration
50
+
51
+ | Variable | Use |
52
+ | :-- | :-- |
53
+ | `IGNITIFY_API_KEY` | Your API key, for CI. It wins over the saved login; the CLI prints one note when both are present. |
54
+ | `IGNITIFY_TASKS_DIR` | The folder that holds your task folders. Default: `tasks`. |
55
+ | `NO_COLOR` | Set to any value to turn colour off. |
56
+
57
+ In CI, put the API key in a CI secret and give it to the job as `IGNITIFY_API_KEY`.
58
+
59
+ ## Where the key is stored
60
+
61
+ `ignitify login` saves the key in `$XDG_CONFIG_HOME/ignitify/credentials.json` when `XDG_CONFIG_HOME` is an absolute path, else in `~/.config/ignitify/credentials.json`. The folder has mode 0700 and the file has mode 0600. `ignitify logout` revokes the key and deletes the file.
62
+
63
+ ## Exit codes
64
+
65
+ | Code | Meaning |
66
+ | :-- | :-- |
67
+ | 0 | The command succeeded. |
68
+ | 1 | The command failed. The CLI prints the error on stderr. |
69
+ | 130 | You pressed Ctrl+C during a wait. |
70
+
71
+ The code is the same under `npx`, `npm exec` and `npm run`, so a CI step fails when the command fails. In an npm script, use `npm run --silent` if you do not want npm's own error lines.
72
+
73
+ ## Proxy
74
+
75
+ The CLI uses the proxy settings of Node.js. Set `NODE_USE_ENV_PROXY=1` together with `HTTPS_PROXY` (Node.js 22.21 or newer):
76
+
77
+ ```sh
78
+ NODE_USE_ENV_PROXY=1 HTTPS_PROXY=http://proxy.example.com:3128 ignitify whoami
79
+ ```
80
+
81
+ ## Update
82
+
83
+ ```sh
84
+ npm install --global ignitify@latest
85
+ ```
86
+
87
+ The CLI does not check for updates in the background. When the service needs a newer CLI, the CLI prints a warning on stderr.
88
+
89
+ ## Uninstall
90
+
91
+ ```sh
92
+ ignitify logout
93
+ npm uninstall --global ignitify
94
+ ```
95
+
96
+ The CLI keeps no data other than the credentials file, and `ignitify logout` deletes it.
97
+
98
+ ## Platforms
99
+
100
+ macOS and Linux (WSL included). Windows is not tested.
101
+
102
+ ## Privacy
103
+
104
+ The CLI sends no telemetry. It sends requests only to the Ignitify API, and only when you run a command.
105
+
106
+ ## Versioning
107
+
108
+ This package follows semantic versioning. The public surface is: command names, flags, exit codes, the `--json` output, `IGNITIFY_API_KEY`, `IGNITIFY_TASKS_DIR`, the credentials path, and the supported Node.js versions. A change that breaks one of these comes only in a new major version.
109
+
110
+ ## Support and security
111
+
112
+ Send bug reports and security reports to admin@ignitify.dev, or use https://ignitify.dev/contact. Docs: https://ignitify.dev/docs.
113
+
114
+ Never paste an API key into a report.
115
+
116
+ ## Licence
117
+
118
+ See LICENSE. The licences of third-party code in this package are in `ignitify-NOTICE.txt`.
package/ignitify-NOTICE.txt CHANGED
@@ -57,7 +57,7 @@ SOFTWARE.
57
57
 
58
58
  ==============================================================================
59
59
 
60
- fast-uri 3.1.8 — BSD-3-Clause
60
+ fast-uri 3.1.9 — BSD-3-Clause
61
61
 
62
62
  Copyright (c) 2011-2021, Gary Court until https://github.com/garycourt/uri-js/commit/a1acf730b4bba3f1097c9f52e7d9d3aba8cdcaae
63
63
  Copyright (c) 2021-present The Fastify team <https://github.com/fastify/fastify#team>