nemar-cli 0.6.0 → 0.6.1-dev.299
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 +49 -28
- package/dist/index.js +167 -164
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -68,14 +68,20 @@ gh auth login
|
|
|
68
68
|
# 1. Sign up for NEMAR
|
|
69
69
|
nemar auth signup
|
|
70
70
|
|
|
71
|
-
# 2. After admin approval,
|
|
71
|
+
# 2. After admin approval, retrieve your API key
|
|
72
|
+
nemar auth retrieve-key
|
|
73
|
+
|
|
74
|
+
# 3. Login with your API key
|
|
72
75
|
nemar auth login
|
|
73
76
|
|
|
74
|
-
#
|
|
77
|
+
# 4. Complete sandbox training
|
|
78
|
+
nemar sandbox
|
|
79
|
+
|
|
80
|
+
# 5. Validate your BIDS dataset
|
|
75
81
|
nemar dataset validate /path/to/dataset
|
|
76
82
|
|
|
77
|
-
#
|
|
78
|
-
nemar dataset upload /path/to/dataset
|
|
83
|
+
# 6. Upload to NEMAR
|
|
84
|
+
nemar dataset upload /path/to/dataset
|
|
79
85
|
```
|
|
80
86
|
|
|
81
87
|
## Architecture Overview
|
|
@@ -268,34 +274,41 @@ sequenceDiagram
|
|
|
268
274
|
### Authentication
|
|
269
275
|
|
|
270
276
|
```bash
|
|
271
|
-
nemar auth signup
|
|
272
|
-
nemar auth
|
|
273
|
-
nemar auth
|
|
274
|
-
nemar auth
|
|
277
|
+
nemar auth signup # Register new account
|
|
278
|
+
nemar auth retrieve-key # Retrieve API key after approval
|
|
279
|
+
nemar auth login # Login with API key
|
|
280
|
+
nemar auth status # Check authentication status
|
|
281
|
+
nemar auth switch # Switch between accounts
|
|
282
|
+
nemar auth logout # Remove active account (--all for all)
|
|
283
|
+
nemar auth setup-ssh # Configure SSH for GitHub
|
|
284
|
+
nemar auth regenerate-key # Request new API key
|
|
275
285
|
```
|
|
276
286
|
|
|
277
287
|
### Dataset Management
|
|
278
288
|
|
|
279
289
|
```bash
|
|
280
|
-
nemar dataset validate <path>
|
|
281
|
-
nemar dataset upload <path>
|
|
282
|
-
nemar dataset download <id>
|
|
283
|
-
nemar dataset clone <id>
|
|
284
|
-
nemar dataset
|
|
285
|
-
nemar dataset
|
|
286
|
-
nemar dataset
|
|
287
|
-
nemar dataset
|
|
290
|
+
nemar dataset validate <path> # Validate BIDS dataset
|
|
291
|
+
nemar dataset upload <path> # Upload new dataset
|
|
292
|
+
nemar dataset download <id> # Download dataset (with data)
|
|
293
|
+
nemar dataset clone <id> # Clone metadata only
|
|
294
|
+
nemar dataset get [files] # Download annexed data files
|
|
295
|
+
nemar dataset drop [files] # Free local copies of data
|
|
296
|
+
nemar dataset list # List all datasets (--mine for own)
|
|
297
|
+
nemar dataset status <id> # Check dataset status
|
|
298
|
+
nemar dataset release <id> # Create version bump PR
|
|
299
|
+
nemar dataset update [path] # Push local changes via PR
|
|
300
|
+
nemar dataset save # Stage and commit changes
|
|
301
|
+
nemar dataset push # Push commits and data
|
|
302
|
+
nemar dataset ci [id] # Check BIDS validation CI status
|
|
303
|
+
nemar dataset manifest [ver] # View version manifests
|
|
288
304
|
```
|
|
289
305
|
|
|
290
|
-
###
|
|
306
|
+
### Collaboration
|
|
291
307
|
|
|
292
308
|
```bash
|
|
293
|
-
nemar dataset
|
|
294
|
-
nemar dataset
|
|
295
|
-
nemar dataset
|
|
296
|
-
nemar dataset pr show <pr-id> # View PR details
|
|
297
|
-
nemar dataset pr update <pr-id> # Push updates to PR
|
|
298
|
-
nemar dataset pr close <pr-id> # Close PR without merging
|
|
309
|
+
nemar dataset request-access <id> # Request collaborator access
|
|
310
|
+
nemar dataset invite <user> <id> # Invite collaborator
|
|
311
|
+
nemar dataset collaborators <id> # List collaborators
|
|
299
312
|
```
|
|
300
313
|
|
|
301
314
|
### Publication Workflow
|
|
@@ -321,14 +334,22 @@ nemar admin users # List all users
|
|
|
321
334
|
nemar admin users --pending # List pending approvals
|
|
322
335
|
nemar admin approve <username> # Approve user
|
|
323
336
|
nemar admin revoke <username> # Revoke user access
|
|
337
|
+
nemar admin role <username> <role> # Change user role
|
|
324
338
|
|
|
325
|
-
# Dataset
|
|
326
|
-
nemar admin
|
|
327
|
-
nemar admin
|
|
328
|
-
nemar admin
|
|
339
|
+
# Dataset management
|
|
340
|
+
nemar admin repo public <id> # Make repo public
|
|
341
|
+
nemar admin repo private <id> # Make repo private
|
|
342
|
+
nemar admin ci check <id> # Check CI status
|
|
343
|
+
nemar admin ci add <id> # Deploy CI workflows
|
|
344
|
+
nemar admin s3 regenerate-iam <user> # Regenerate AWS credentials
|
|
345
|
+
nemar admin make-public <id> # Publish dataset (permanent)
|
|
346
|
+
nemar admin delete-dataset <id> # Delete dataset
|
|
329
347
|
|
|
330
348
|
# DOI management
|
|
331
|
-
nemar admin doi create <
|
|
349
|
+
nemar admin doi create <id> # Create concept DOI
|
|
350
|
+
nemar admin doi info <id> # Get DOI info
|
|
351
|
+
nemar admin doi update <id> # Update DOI metadata
|
|
352
|
+
nemar admin doi enrich <id> # Enrich DOI metadata
|
|
332
353
|
```
|
|
333
354
|
|
|
334
355
|
## Access Control
|