nemar-cli 0.9.17-dev.2347 → 0.9.17-dev.2362
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 +27 -19
- package/dist/index.js +366 -275
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -68,25 +68,22 @@ gh auth login
|
|
|
68
68
|
## Quick Start
|
|
69
69
|
|
|
70
70
|
```bash
|
|
71
|
-
# 1. Sign up for NEMAR
|
|
71
|
+
# 1. Sign up for NEMAR (opens your browser to sign in with ORCID, then a few quick questions)
|
|
72
72
|
nemar auth signup
|
|
73
73
|
|
|
74
|
-
# 2.
|
|
75
|
-
nemar auth retrieve-key
|
|
76
|
-
|
|
77
|
-
# 3. Login with your API key
|
|
78
|
-
nemar auth login
|
|
79
|
-
|
|
80
|
-
# 4. Complete sandbox training
|
|
74
|
+
# 2. Complete sandbox training
|
|
81
75
|
nemar sandbox
|
|
82
76
|
|
|
83
|
-
#
|
|
77
|
+
# 3. Validate your BIDS dataset
|
|
84
78
|
nemar dataset validate /path/to/dataset
|
|
85
79
|
|
|
86
|
-
#
|
|
80
|
+
# 4. Upload to NEMAR
|
|
87
81
|
nemar dataset upload /path/to/dataset
|
|
88
82
|
```
|
|
89
83
|
|
|
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
|
+
|
|
90
87
|
## Architecture Overview
|
|
91
88
|
|
|
92
89
|
```mermaid
|
|
@@ -277,14 +274,13 @@ sequenceDiagram
|
|
|
277
274
|
### Authentication
|
|
278
275
|
|
|
279
276
|
```bash
|
|
280
|
-
nemar auth signup #
|
|
281
|
-
nemar auth
|
|
282
|
-
nemar auth login # Login with API key
|
|
277
|
+
nemar auth signup # Sign in with your browser; create or continue your account
|
|
278
|
+
nemar auth login # Sign in with your browser (-k/--key to paste an existing key)
|
|
283
279
|
nemar auth status # Check authentication status
|
|
284
280
|
nemar auth switch # Switch between accounts
|
|
285
281
|
nemar auth logout # Remove active account (--all for all)
|
|
286
282
|
nemar auth setup-ssh # Configure SSH for GitHub
|
|
287
|
-
nemar auth
|
|
283
|
+
nemar auth keys # List, create, or revoke this account's named API keys
|
|
288
284
|
```
|
|
289
285
|
|
|
290
286
|
### Dataset Management
|
|
@@ -444,8 +440,8 @@ See [the Zenodo testing guide](https://docs.nemar.org/develop/zenodo-testing/) f
|
|
|
444
440
|
### CLI Usage
|
|
445
441
|
|
|
446
442
|
```bash
|
|
447
|
-
NEMAR_API_KEY # API key (alternative to login)
|
|
448
|
-
|
|
443
|
+
NEMAR_API_KEY # API key (alternative to `nemar auth login -k`)
|
|
444
|
+
NEMAR_NO_BROWSER=1 # Never try to open a browser during sign-in (same as --no-open)
|
|
449
445
|
NEMAR_NO_COLOR # Disable colored output
|
|
450
446
|
```
|
|
451
447
|
|
|
@@ -517,9 +513,21 @@ nemar auth logout
|
|
|
517
513
|
nemar auth login
|
|
518
514
|
```
|
|
519
515
|
|
|
520
|
-
**
|
|
521
|
-
-
|
|
522
|
-
|
|
516
|
+
**Browser doesn't open, or you're on a headless/remote host**
|
|
517
|
+
- The printed link is the real mechanism, not the browser: copy it into any
|
|
518
|
+
browser, on any machine, and authorize there
|
|
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
|
|
523
531
|
|
|
524
532
|
### Branch Protection
|
|
525
533
|
|