dorky 2.4.0 → 2.4.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 +24 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,6 +11,8 @@
|
|
|
11
11
|
[`DevOps Records Keeper`](https://dorky.trishantpahwa.me/)
|
|
12
12
|
|
|
13
13
|
[](https://npmjs.com/package/dorky)
|
|
14
|
+
[](https://npmjs.com/package/dorky)
|
|
15
|
+
[](https://npmjs.com/package/dorky)
|
|
14
16
|
|
|
15
17
|
 `&& ` 
|
|
16
18
|
|
|
@@ -125,7 +127,7 @@ dorky --push
|
|
|
125
127
|
|
|
126
128
|
## Usage
|
|
127
129
|
|
|
128
|
-
### Initialize a Project
|
|
130
|
+
### Initialize a Project (`-i`)
|
|
129
131
|
|
|
130
132
|
```bash
|
|
131
133
|
# For AWS S3
|
|
@@ -141,7 +143,7 @@ This creates:
|
|
|
141
143
|
- `.dorkyignore` file for exclusion patterns
|
|
142
144
|
- Updates `.gitignore` to protect credentials
|
|
143
145
|
|
|
144
|
-
### List Files
|
|
146
|
+
### List Files (`-l`)
|
|
145
147
|
|
|
146
148
|
```bash
|
|
147
149
|
# List local files (shows what can be added)
|
|
@@ -151,7 +153,7 @@ dorky --list
|
|
|
151
153
|
dorky --list remote
|
|
152
154
|
```
|
|
153
155
|
|
|
154
|
-
### Add Files to Stage
|
|
156
|
+
### Add Files to Stage (`-a`)
|
|
155
157
|
|
|
156
158
|
```bash
|
|
157
159
|
# Add single file
|
|
@@ -164,7 +166,7 @@ dorky --add .env config.yml secrets.json
|
|
|
164
166
|
dorky --add .env.production .env.staging
|
|
165
167
|
```
|
|
166
168
|
|
|
167
|
-
### Remove Files from Stage
|
|
169
|
+
### Remove Files from Stage (`-r`)
|
|
168
170
|
|
|
169
171
|
```bash
|
|
170
172
|
# Remove single file
|
|
@@ -174,7 +176,7 @@ dorky --rm .env
|
|
|
174
176
|
dorky --rm .env config.yml
|
|
175
177
|
```
|
|
176
178
|
|
|
177
|
-
### Push Files to Storage
|
|
179
|
+
### Push Files to Storage (`-ph`)
|
|
178
180
|
|
|
179
181
|
```bash
|
|
180
182
|
# Push all staged files
|
|
@@ -185,9 +187,10 @@ This command:
|
|
|
185
187
|
|
|
186
188
|
- Uploads new files
|
|
187
189
|
- Updates modified files (based on hash comparison)
|
|
190
|
+
- Removes files from remote storage that were unstaged using `dorky --rm`
|
|
188
191
|
- Skips unchanged files
|
|
189
192
|
|
|
190
|
-
### Pull Files from Storage
|
|
193
|
+
### Pull Files from Storage (`-pl`)
|
|
191
194
|
|
|
192
195
|
```bash
|
|
193
196
|
# Pull all tracked files
|
|
@@ -200,6 +203,19 @@ This command:
|
|
|
200
203
|
- Creates necessary directories
|
|
201
204
|
- Overwrites local files
|
|
202
205
|
|
|
206
|
+
### Destroy Project (`-d`)
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
# Destroy project locally and remotely
|
|
210
|
+
dorky --destroy
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
This command:
|
|
214
|
+
|
|
215
|
+
- Deletes all tracked files from remote storage
|
|
216
|
+
- Removes local `.dorky/` directory and `.dorkyignore` file
|
|
217
|
+
- **Warning**: This action is irreversible for remote files.
|
|
218
|
+
|
|
203
219
|
## Configuration
|
|
204
220
|
|
|
205
221
|
### .dorkyignore
|
|
@@ -318,6 +334,8 @@ dorky --pull
|
|
|
318
334
|
- ✅ File hash validation to skip unchanged files
|
|
319
335
|
- ✅ Mime-type detection for file uploads
|
|
320
336
|
- ✅ Recursive folder creation on pull
|
|
337
|
+
- ✅ Destroy project and clean up remote files
|
|
338
|
+
- ✅ Auto-recovery of AWS credentials from environment variables
|
|
321
339
|
|
|
322
340
|
## How It Works
|
|
323
341
|
|