para-cli 1.24.0 → 1.24.1

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 (2) hide show
  1. package/README.md +17 -7
  2. package/package.json +8 -8
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Para Command-Line Interface (CLI)
4
4
 
5
- [![NPM version][https://badge.fury.io/js/para-cli.svg]][https://npmjs.org/package/para-cli]
5
+ [![NPM version](https://badge.fury.io/js/para-cli.svg)](https://npmjs.org/package/para-cli)
6
6
  [![Join the chat at https://gitter.im/Erudika/para](https://badges.gitter.im/Erudika/para.svg)](https://gitter.im/Erudika/para?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7
7
 
8
8
  ## What is this?
@@ -16,6 +16,13 @@ This is the command-line tool for interacting with a Para server.
16
16
 
17
17
  ## Installation
18
18
 
19
+ Run it directly without installing:
20
+ ```sh
21
+ npx para-cli
22
+ ```
23
+
24
+ **Or**, install it globally:
25
+
19
26
  ```sh
20
27
  npm install -g para-cli
21
28
  para-cli setup
@@ -40,8 +47,9 @@ para-cli ping
40
47
  Commands:
41
48
  setup Initial setup, prompts you to enter your Para API keys and endpoint
42
49
  apps Returns a list of all Para apps
43
- select <appid> Selects a Para app as a target for all subsequent read/write requests.
44
- endpoints [add|remove] List and select Para server endpoints, add new or remove an exiting one.
50
+ types Returns an object containing all currently defined data types in Para
51
+ select <appid> Selects a Para app as a target for all subsequent read/write requests
52
+ endpoints [add|remove] List and select Para server endpoints, add new or remove an exiting one
45
53
  create <file|glob> [--id] [--type] Persists files as Para objects and makes them searchable
46
54
  read --id 123 [--id 345 ...] Fetches objects with the given ids
47
55
  update <file.json|glob> ... Updates Para objects with the data from a JSON file (must contain id field)
@@ -50,9 +58,9 @@ para-cli ping
50
58
  rebuild-index Rebuilds the entire search index
51
59
  app-settings Returns all settings for the authenticated app
52
60
  new-key Generates a new secret key and saves it to config.json
53
- new-jwt Generates a new JWT super token to be used for app authentication
54
- new-app <name> --name --shared Creates a new Para app. Only works if you have the keys for the "root" app
55
- delete-app <id> Deletes an existing Para app. Only works for child apps, not the "root" app
61
+ new-jwt Generates a new JWT super token to be used for app authentication (use --print for console output)
62
+ new-app <name> --name --shared Creates a new Para app (only works if you have the keys for the "root" app)
63
+ delete-app <id> Deletes an existing Para app (only works for child apps, not the "root" app)
56
64
  export Exports all data from the app's table
57
65
  import <file> Imports data from a previously exported ZIP archive
58
66
  ping Tests the connection to the Para server
@@ -71,7 +79,7 @@ para-cli ping
71
79
  --limit Limits the number of search results
72
80
  --lastKey Sets the last id for search-after pagination
73
81
  --cwd Sets the current directory - used for resolving file paths
74
- --encodeId By default all ids are Base64 encoded, unless this is 'false'
82
+ --encodeId By default all ids are Base64 encoded, unless this is set to 'false'
75
83
  --help Prints the list of commands
76
84
  --version Prints the version of the program
77
85
 
@@ -85,7 +93,9 @@ para-cli ping
85
93
  $ para-cli search "*" --type article --page all
86
94
  $ para-cli new-key
87
95
  $ para-cli new-app "mynewapp" --name "Full app name"
96
+ $ para-cli new-jwt --print
88
97
  $ para-cli apps
98
+ $ para-cli types
89
99
  $ para-cli select scoold
90
100
  $ para-cli endpoints
91
101
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "para-cli",
3
- "version": "1.24.0",
3
+ "version": "1.24.1",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Command-line tool for Para backend servers",
6
6
  "homepage": "https://paraio.org",
@@ -26,17 +26,17 @@
26
26
  "api"
27
27
  ],
28
28
  "devDependencies": {
29
- "@biomejs/biome": "2.4.10",
30
- "eslint": "^10.1.0",
31
- "release-it": "^19.2.4"
29
+ "@biomejs/biome": "^2.4.12",
30
+ "eslint": "^10.2.0",
31
+ "release-it": "^20.0.0"
32
32
  },
33
33
  "repository": {
34
34
  "type": "git",
35
35
  "url": "git+https://github.com/Erudika/para-cli.git"
36
36
  },
37
37
  "dependencies": {
38
- "@inquirer/input": "^5.0.10",
39
- "@inquirer/password": "^5.0.10",
38
+ "@inquirer/input": "^5.0.11",
39
+ "@inquirer/password": "^5.0.11",
40
40
  "brace-expansion": "^5.0.5",
41
41
  "chalk": "^5.6.2",
42
42
  "conf": "^15.1.0",
@@ -48,8 +48,8 @@
48
48
  "jsonwebtoken": "^9.0.3",
49
49
  "meow": "^14.1.0",
50
50
  "mime-types": "^3.0.2",
51
- "para-client-js": "^1.40.6",
52
- "resolve": "^1.22.11",
51
+ "para-client-js": "^1.40.7",
52
+ "resolve": "^1.22.12",
53
53
  "striptags": "^3.2.0",
54
54
  "update-notifier": "^7.3.1",
55
55
  "yargs-parser": "^22.0.0"