sharetribe-cli 1.16.0 → 1.16.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.
- package/README.md +76 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Sharetribe CLI
|
|
2
|
+
|
|
3
|
+
An unofficial command-line interface for [Sharetribe](https://www.sharetribe.com/). Sharetribe CLI enables you to
|
|
4
|
+
manage the transaction processes, transactional email templates, assets, and other resources of your marketplaces.
|
|
5
|
+
|
|
6
|
+
This CLI is designed to be 100% compatible with the official `flex-cli`, using the same command structure and configuration files.
|
|
7
|
+
|
|
8
|
+
To use Sharetribe CLI, you will need a marketplace and an admin user API key. You can create a Sharetribe marketplace from
|
|
9
|
+
[www.sharetribe.com/](https://www.sharetribe.com/) and get credentials to Console where you can generate new API keys in [your account's "Manage API keys"](https://console.sharetribe.com/api-keys).
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
Install with npm:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g sharetribe-cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
or with yarn:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
yarn global add sharetribe-cli
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
To verify the installation and to see available commands, run:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
sharetribe-cli
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
First, authenticate with your marketplace:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
sharetribe-cli login
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The CLI will prompt you for your API key and marketplace ID. These credentials are stored in `~/.config/sharetribe-cli/auth.edn`.
|
|
40
|
+
|
|
41
|
+
### Available commands
|
|
42
|
+
|
|
43
|
+
The CLI supports all commands available in the official flex-cli:
|
|
44
|
+
|
|
45
|
+
- `process` - Manage transaction processes (list, create, push, pull, deploy, aliases)
|
|
46
|
+
- `assets` - Manage marketplace assets
|
|
47
|
+
- `events` - Query and tail marketplace events
|
|
48
|
+
- `notifications` - Manage and preview email notifications
|
|
49
|
+
- `listing-approval` - Manage listing approval settings
|
|
50
|
+
- `search` - Manage search schemas
|
|
51
|
+
- `stripe` - Manage Stripe integration
|
|
52
|
+
- `version` - Display version information
|
|
53
|
+
- `help` - Display help for any command
|
|
54
|
+
|
|
55
|
+
Use `--help` to see all available commands and their options:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
sharetribe-cli --help
|
|
59
|
+
sharetribe-cli process --help
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Compatibility
|
|
63
|
+
|
|
64
|
+
This CLI is designed to be a drop-in replacement for the official `flex-cli`. It uses the same configuration files (`~/.config/sharetribe-cli/` or `~/.config/flex-cli/`) and command structure.
|
|
65
|
+
|
|
66
|
+
## SDK
|
|
67
|
+
|
|
68
|
+
This CLI is built using the [`sharetribe-flex-build-sdk`](https://www.npmjs.com/package/sharetribe-flex-build-sdk), which is also available for programmatic use in your own applications.
|
|
69
|
+
|
|
70
|
+
## Issues
|
|
71
|
+
|
|
72
|
+
If you encounter any issues, please report them at [github.com/jayenashar/sharetribe-cli/issues](https://github.com/jayenashar/sharetribe-cli/issues).
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sharetribe-cli",
|
|
3
|
-
"version": "1.16.
|
|
3
|
+
"version": "1.16.1",
|
|
4
4
|
"description": "Unofficial Sharetribe CLI - 100% compatible with flex-cli",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"commander": "^12.1.0",
|
|
42
42
|
"inquirer": "^9.2.23",
|
|
43
43
|
"jsedn": "^0.4.1",
|
|
44
|
-
"sharetribe-flex-build-sdk": "^1.
|
|
44
|
+
"sharetribe-flex-build-sdk": "^1.16.1",
|
|
45
45
|
"yargs": "^18.0.0",
|
|
46
46
|
"yauzl": "^3.2.0"
|
|
47
47
|
},
|