puter-cli 1.0.0 → 1.0.2
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 +38 -17
- package/commands/init.js +1 -1
- package/package.json +15 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Puter-CLI
|
|
2
2
|
|
|
3
|
-
The **Puter CLI** is a command-line interface tool designed to interact with the **Puter Cloud Platform**.
|
|
3
|
+
The **Puter CLI** is a command-line interface tool designed to interact with the **Puter Cloud Platform**. If you don't have an account you can [Signup](https://puter.com/?r=N5Y0ZYTF) from here for free. This cli tool allows users to manage files, directories, applications, and other resources directly from the terminal. This tool is ideal for developers and power users who prefer working with command-line utilities.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -20,30 +20,30 @@ The **Puter CLI** is a command-line interface tool designed to interact with the
|
|
|
20
20
|
## Installation
|
|
21
21
|
|
|
22
22
|
### Prerequisites
|
|
23
|
-
- Node.js (
|
|
23
|
+
- Node.js (v18 or higher)
|
|
24
24
|
- npm (v7 or higher)
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
cd puter-cli
|
|
31
|
-
```
|
|
32
|
-
2. Install dependencies:
|
|
33
|
-
```bash
|
|
34
|
-
npm install
|
|
35
|
-
```
|
|
36
|
-
3. Link the CLI globally:
|
|
37
|
-
```bash
|
|
38
|
-
npm link
|
|
39
|
-
```
|
|
26
|
+
Run the following command to install puter-cli globally in your system:
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g puter-cli
|
|
29
|
+
```
|
|
40
30
|
|
|
41
|
-
|
|
31
|
+
Execute the following command to check the installation process:
|
|
32
|
+
```bash
|
|
33
|
+
puter help
|
|
34
|
+
```
|
|
42
35
|
|
|
43
36
|
## Usage
|
|
44
37
|
|
|
45
38
|
### Commands
|
|
46
39
|
|
|
40
|
+
#### Initilize a project
|
|
41
|
+
- **Create a new project**: Initilize a new project
|
|
42
|
+
```bash
|
|
43
|
+
puter init
|
|
44
|
+
```
|
|
45
|
+
Then just follow the prompts, this command doesn't require you to login.
|
|
46
|
+
|
|
47
47
|
#### Authentication
|
|
48
48
|
- **Login**: Log in to your Puter account.
|
|
49
49
|
```bash
|
|
@@ -219,6 +219,27 @@ or just type (you'll need to login):
|
|
|
219
219
|
|
|
220
220
|
---
|
|
221
221
|
|
|
222
|
+
## Development
|
|
223
|
+
|
|
224
|
+
If you want to customize this tool you can follow these steps:
|
|
225
|
+
|
|
226
|
+
### Steps
|
|
227
|
+
1. Clone the repository:
|
|
228
|
+
```bash
|
|
229
|
+
git clone https://github.com/bitsnaps/puter-cli.git
|
|
230
|
+
cd puter-cli
|
|
231
|
+
```
|
|
232
|
+
2. Install dependencies:
|
|
233
|
+
```bash
|
|
234
|
+
npm install
|
|
235
|
+
```
|
|
236
|
+
3. Link the CLI globally:
|
|
237
|
+
```bash
|
|
238
|
+
npm link
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
---
|
|
242
|
+
|
|
222
243
|
## Known issues:
|
|
223
244
|
|
|
224
245
|
Most of the functionalities are just working fine, however some APIs related to Puter's SDK have some known issues. We tried to fix most them but some of them are not related to us, so we let you about that in case it'll be fixed by Puter's in the future:
|
package/commands/init.js
CHANGED
package/package.json
CHANGED
|
@@ -1,24 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "puter-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Command line interface for Puter cloud platform",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"puter": "./bin/index.js"
|
|
8
8
|
},
|
|
9
|
+
"preferGlobal": true,
|
|
9
10
|
"type": "module",
|
|
10
11
|
"scripts": {
|
|
11
12
|
"start": "node bin/index.js",
|
|
12
13
|
"test": "vitest run tests/*",
|
|
13
14
|
"test:watch": "vitest --watch tests/*"
|
|
14
15
|
},
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=18.0.0"
|
|
18
|
+
},
|
|
15
19
|
"keywords": [
|
|
16
20
|
"puter",
|
|
17
21
|
"cli",
|
|
18
22
|
"cloud"
|
|
19
23
|
],
|
|
20
24
|
"author": "Ibrahim.H",
|
|
21
|
-
"license": "
|
|
25
|
+
"license": "NoHarm",
|
|
22
26
|
"dependencies": {
|
|
23
27
|
"chalk": "^5.3.0",
|
|
24
28
|
"cli-table3": "^0.6.5",
|
|
@@ -33,5 +37,13 @@
|
|
|
33
37
|
},
|
|
34
38
|
"devDependencies": {
|
|
35
39
|
"vitest": "^2.1.8"
|
|
36
|
-
}
|
|
40
|
+
},
|
|
41
|
+
"repository": {
|
|
42
|
+
"type": "git",
|
|
43
|
+
"url": "git+https://github.com/bitsnaps/puter-cli.git"
|
|
44
|
+
},
|
|
45
|
+
"bugs": {
|
|
46
|
+
"url": "https://github.com/bitsnaps/puter-cli/issues"
|
|
47
|
+
},
|
|
48
|
+
"homepage": "https://github.com/bitsnaps/puter-cli"
|
|
37
49
|
}
|