nemar-cli 0.9.17-PR1291.3bf7aef → 0.9.17-PR1292.af244ff
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 +19 -27
- package/dist/index.js +275 -366
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -68,22 +68,25 @@ gh auth login
|
|
|
68
68
|
## Quick Start
|
|
69
69
|
|
|
70
70
|
```bash
|
|
71
|
-
# 1. Sign up for NEMAR
|
|
71
|
+
# 1. Sign up for NEMAR
|
|
72
72
|
nemar auth signup
|
|
73
73
|
|
|
74
|
-
# 2.
|
|
74
|
+
# 2. After admin approval, retrieve your API key
|
|
75
|
+
nemar auth retrieve-key
|
|
76
|
+
|
|
77
|
+
# 3. Login with your API key
|
|
78
|
+
nemar auth login
|
|
79
|
+
|
|
80
|
+
# 4. Complete sandbox training
|
|
75
81
|
nemar sandbox
|
|
76
82
|
|
|
77
|
-
#
|
|
83
|
+
# 5. Validate your BIDS dataset
|
|
78
84
|
nemar dataset validate /path/to/dataset
|
|
79
85
|
|
|
80
|
-
#
|
|
86
|
+
# 6. Upload to NEMAR
|
|
81
87
|
nemar dataset upload /path/to/dataset
|
|
82
88
|
```
|
|
83
89
|
|
|
84
|
-
On another machine, `nemar auth login` signs in the same way (browser by default; `--key <api-key>`
|
|
85
|
-
pastes an existing key for a host that cannot open one).
|
|
86
|
-
|
|
87
90
|
## Architecture Overview
|
|
88
91
|
|
|
89
92
|
```mermaid
|
|
@@ -274,13 +277,14 @@ sequenceDiagram
|
|
|
274
277
|
### Authentication
|
|
275
278
|
|
|
276
279
|
```bash
|
|
277
|
-
nemar auth signup #
|
|
278
|
-
nemar auth
|
|
280
|
+
nemar auth signup # Register new account
|
|
281
|
+
nemar auth retrieve-key # Retrieve API key after approval
|
|
282
|
+
nemar auth login # Login with API key
|
|
279
283
|
nemar auth status # Check authentication status
|
|
280
284
|
nemar auth switch # Switch between accounts
|
|
281
285
|
nemar auth logout # Remove active account (--all for all)
|
|
282
286
|
nemar auth setup-ssh # Configure SSH for GitHub
|
|
283
|
-
nemar auth
|
|
287
|
+
nemar auth regenerate-key # Request new API key
|
|
284
288
|
```
|
|
285
289
|
|
|
286
290
|
### Dataset Management
|
|
@@ -440,8 +444,8 @@ See [the Zenodo testing guide](https://docs.nemar.org/develop/zenodo-testing/) f
|
|
|
440
444
|
### CLI Usage
|
|
441
445
|
|
|
442
446
|
```bash
|
|
443
|
-
NEMAR_API_KEY # API key (alternative to
|
|
444
|
-
|
|
447
|
+
NEMAR_API_KEY # API key (alternative to login)
|
|
448
|
+
NEMAR_API_URL # Custom API endpoint (default: https://api.nemar.org)
|
|
445
449
|
NEMAR_NO_COLOR # Disable colored output
|
|
446
450
|
```
|
|
447
451
|
|
|
@@ -513,21 +517,9 @@ nemar auth logout
|
|
|
513
517
|
nemar auth login
|
|
514
518
|
```
|
|
515
519
|
|
|
516
|
-
**
|
|
517
|
-
-
|
|
518
|
-
|
|
519
|
-
- `nemar auth login --no-open` (or `NEMAR_NO_BROWSER=1`) skips the attempt
|
|
520
|
-
entirely and just prints the link
|
|
521
|
-
- If nothing can open a browser at all, paste an existing key instead:
|
|
522
|
-
`nemar auth login -k <api-key>` (create one with `nemar auth keys create`
|
|
523
|
-
on a machine that can)
|
|
524
|
-
|
|
525
|
-
**Upload access is not granted yet**
|
|
526
|
-
- Upload access is a separate, one-time admin approval requested with
|
|
527
|
-
`nemar auth request-upload-access` (or automatically at the end of
|
|
528
|
-
`nemar auth signup`)
|
|
529
|
-
- Browsing, downloading, and sandbox training all work without it
|
|
530
|
-
- Contact your NEMAR administrator if the request has been pending a while
|
|
520
|
+
**"Account pending approval"**
|
|
521
|
+
- Admin must approve your account after signup
|
|
522
|
+
- Contact your NEMAR administrator
|
|
531
523
|
|
|
532
524
|
### Branch Protection
|
|
533
525
|
|