replicate-predictions-downloader 2.0.3 → 2.0.4

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 (3) hide show
  1. package/README.md +42 -12
  2. package/index.js +1 -0
  3. package/package.json +5 -1
package/README.md CHANGED
@@ -29,6 +29,10 @@ A Node.js script to download and organize all your Replicate predictions, includ
29
29
  ## Quick Start
30
30
 
31
31
  ```bash
32
+ # First time - download all predictions
33
+ npx replicate-predictions-downloader
34
+
35
+ # Subsequent runs - download only new predictions since last run (optional)
32
36
  npx replicate-predictions-downloader --last-run
33
37
  ```
34
38
 
@@ -51,7 +55,31 @@ Replicate deletes predictions after 30 days. If you've been experimenting with m
51
55
 
52
56
  ### Installation
53
57
 
54
- #### Option 1: Clone and install locally
58
+ Choose the method that best fits your needs:
59
+
60
+ #### Option 1: Quick one-time use (no installation needed)
61
+
62
+ Perfect for trying out the tool or occasional use. Downloads and runs the latest version directly:
63
+
64
+ ```bash
65
+ npx replicate-predictions-downloader
66
+ ```
67
+
68
+ #### Option 2: Install globally for repeated use
69
+
70
+ Best if you'll be using this tool regularly. Installs a permanent command on your system:
71
+
72
+ ```bash
73
+ # Install globally
74
+ npm install -g replicate-predictions-downloader
75
+
76
+ # Then run anytime with:
77
+ replicate-downloader
78
+ ```
79
+
80
+ #### Option 3: Clone and customize
81
+
82
+ For developers who want to modify the code or contribute to the project:
55
83
 
56
84
  ```bash
57
85
  # Clone the repository
@@ -60,12 +88,11 @@ cd replicate-predictions-downloader
60
88
 
61
89
  # Install dependencies
62
90
  npm install
63
- ```
64
91
 
65
- #### Option 2: Install via npm
66
-
67
- ```bash
68
- npm install -g replicate-predictions-downloader
92
+ # Run the tool
93
+ npm start
94
+ # or
95
+ node index.js
69
96
  ```
70
97
 
71
98
  ### API Token Setup
@@ -88,16 +115,19 @@ Set your API token using one of these methods:
88
115
 
89
116
  ### Basic Usage
90
117
 
91
- Run the script:
92
- ```bash
93
- # If installed locally
94
- npm start
118
+ Run the tool based on how you installed it:
95
119
 
96
- # Or directly
97
- node index.js
120
+ ```bash
121
+ # If using npx (no installation)
122
+ npx replicate-predictions-downloader
98
123
 
99
124
  # If installed globally
100
125
  replicate-downloader
126
+
127
+ # If cloned locally
128
+ npm start
129
+ # or
130
+ node index.js
101
131
  ```
102
132
 
103
133
  ## What You'll See
package/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ #!/usr/bin/env node
1
2
  import fs from 'fs';
2
3
  import path from 'path';
3
4
  import https from 'https';
package/package.json CHANGED
@@ -1,9 +1,13 @@
1
1
  {
2
2
  "name": "replicate-predictions-downloader",
3
- "version": "2.0.3",
3
+ "version": "2.0.4",
4
4
  "description": "A Node.js script to download and organize all your Replicate predictions, including images, metadata, and other outputs",
5
5
  "main": "index.js",
6
6
  "type": "module",
7
+ "bin": {
8
+ "replicate-downloader": "./index.js",
9
+ "replicate-predictions-downloader": "./index.js"
10
+ },
7
11
  "scripts": {
8
12
  "start": "node index.js",
9
13
  "download": "node index.js",