@quickengine/cli 0.2.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/LICENSE +29 -0
- package/README.md +61 -0
- package/dist/index.js +1849 -0
- package/package.json +49 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
QuickEngine Software — Proprietary Licence
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 QuickEngine Software. All rights reserved.
|
|
4
|
+
|
|
5
|
+
This software and its source code are the confidential and proprietary property
|
|
6
|
+
of QuickEngine Software. They are NOT open source and are NOT licensed for
|
|
7
|
+
public use.
|
|
8
|
+
|
|
9
|
+
No permission is granted to any person or entity to use, copy, modify, merge,
|
|
10
|
+
publish, distribute, sublicense, sell, or create derivative works from this
|
|
11
|
+
software or any portion of it, in source or binary form, except under a separate
|
|
12
|
+
written agreement signed by QuickEngine Software.
|
|
13
|
+
|
|
14
|
+
Access to this repository — whether granted directly, through an employer, or
|
|
15
|
+
incidentally — does not confer any licence, title, or ownership interest.
|
|
16
|
+
|
|
17
|
+
Certain client libraries published to public registries by QuickEngine Software
|
|
18
|
+
are distributed under their own licence terms, stated in their respective
|
|
19
|
+
package manifests. Those terms apply only to the published artefacts of those
|
|
20
|
+
packages, and never to this repository as a whole.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
24
|
+
FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
25
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER
|
|
26
|
+
IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN
|
|
27
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
28
|
+
|
|
29
|
+
For licensing enquiries: quickenginesw@gmail.com
|
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @quickengine/cli
|
|
2
|
+
|
|
3
|
+
`quick` — the QuickEngine command-line tool. It's the ecosystem-level CLI (a peer of the
|
|
4
|
+
`@quickengine/quick` SDK): you configure a workspace-scoped API key once, then read product
|
|
5
|
+
APIs (QuickDash today) from your terminal.
|
|
6
|
+
|
|
7
|
+
> **Status:** real, not stubbed. Commands follow the deployed `/v1` API and cover activity,
|
|
8
|
+
> bookings, catalog, clients, contracts, files, fulfillment, inventory, invoices, orders,
|
|
9
|
+
> payments, projects, quotes, reports, shipments, time tracking and webhooks. Workspace, module
|
|
10
|
+
> and key management remain in Account because their APIs are session-only.
|
|
11
|
+
|
|
12
|
+
## Setup
|
|
13
|
+
|
|
14
|
+
Point it at a product API origin and a workspace, with a key from **Account → your
|
|
15
|
+
workspace → API keys**:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
quick config set \
|
|
19
|
+
--base-url https://api.quickdash.xyz \
|
|
20
|
+
--workspace <workspace-id> \
|
|
21
|
+
--key qsk_... # qpk_ (publishable), qsk_ (secret), or qsc_ (scoped)
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Config is stored at `~/.quick/config.json` (owner-only perms). Environment variables win
|
|
25
|
+
over the file, so CI needs no written config:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
export QUICK_BASE_URL=https://api.quickdash.xyz
|
|
29
|
+
export QUICK_WORKSPACE=<workspace-id>
|
|
30
|
+
export QUICK_KEY=qsk_...
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Commands
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
quick config set [--base-url <url>] [--workspace <id>] [--key <key>]
|
|
37
|
+
quick config show [--json] # key is masked
|
|
38
|
+
|
|
39
|
+
quick catalog list [--json] # active catalog items
|
|
40
|
+
quick catalog get <id> [--json] # one item with its active variants
|
|
41
|
+
|
|
42
|
+
quick doctor # verify config + key format + API connectivity
|
|
43
|
+
quick init # guided, verified setup
|
|
44
|
+
quick create app <name> # minimal framework-independent connected project
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
`quick doctor` is the first thing to run — it checks your settings, validates the key
|
|
48
|
+
format, and makes a real read to confirm the API is reachable and the key works,
|
|
49
|
+
translating failures into plain language (bad key, module disabled, wrong workspace).
|
|
50
|
+
|
|
51
|
+
Every command takes `--json` where it prints data, so the CLI composes in scripts.
|
|
52
|
+
|
|
53
|
+
Run `quick --help` for the complete resource command list. `quick create app` intentionally
|
|
54
|
+
generates one readable server script rather than choosing a frontend framework for you; the
|
|
55
|
+
multi-framework wizard follows the Connect UX design later.
|
|
56
|
+
|
|
57
|
+
## What's next
|
|
58
|
+
|
|
59
|
+
The command surface grows with the API. Workspace, module and key management arrive when their
|
|
60
|
+
management contracts are suitable for non-browser credentials. See the public API documentation
|
|
61
|
+
for the authoritative HTTP contract.
|