Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort CLI commands, groups and topics alphabetically #2488

Merged
merged 6 commits into from
Dec 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.D/2488.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sort CLI commands, groups and topics alphabetically.
2,704 changes: 1,352 additions & 1,352 deletions CLI.md

Large diffs are not rendered by default.

74 changes: 37 additions & 37 deletions neuro-cli/docs/acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,40 +13,30 @@ Access Control List management.
**Commands:**
| Usage | Description |
| :--- | :--- |
| [_add-role_](acl.md#add-role) | Add new role |
| [_grant_](acl.md#grant) | Shares resource with another user |
| [_revoke_](acl.md#revoke) | Revoke user access from another user |
| [_ls_](acl.md#ls) | List shared resources |
| [_add-role_](acl.md#add-role) | Add new role |
| [_remove-role_](acl.md#remove-role) | Remove existing role |
| [_revoke_](acl.md#revoke) | Revoke user access from another user |


### grant
### add-role

Shares resource with another user
Add new role


#### Usage

```bash
neuro acl grant [OPTIONS] URI USER {read|write|manage}
neuro acl add-role [OPTIONS] ROLE_NAME
```

Shares resource with another user.

`URI` shared resource.

`USER` username to
share resource with.

`PERMISSION` sharing access right: read, write, or
manage.
Add new role.

#### Examples

```bash
$ neuro acl grant storage:///sample_data/ alice manage
$ neuro acl grant image:resnet50 bob read
$ neuro acl grant job:///my_job_id alice write
$ neuro acl add-role mycompany/subdivision
```

#### Options
Expand All @@ -57,30 +47,33 @@ $ neuro acl grant job:///my_job_id alice write



### revoke
### grant

Revoke user access from another user
Shares resource with another user


#### Usage

```bash
neuro acl revoke [OPTIONS] URI USER
neuro acl grant [OPTIONS] URI USER {read|write|manage}
```

Revoke user access from another user.
Shares resource with another user.

`URI` previously shared resource to
revoke.
`URI` shared resource.

`USER` to revoke `URI` resource from.
`USER` username to
share resource with.

`PERMISSION` sharing access right: read, write, or
manage.

#### Examples

```bash
$ neuro acl revoke storage:///sample_data/ alice
$ neuro acl revoke image:resnet50 bob
$ neuro acl revoke job:///my_job_id alice
$ neuro acl grant storage:///sample_data/ alice manage
$ neuro acl grant image:resnet50 bob read
$ neuro acl grant job:///my_job_id alice write
```

#### Options
Expand Down Expand Up @@ -130,23 +123,23 @@ $ neuro acl list --shared image://



### add-role
### remove-role

Add new role
Remove existing role


#### Usage

```bash
neuro acl add-role [OPTIONS] ROLE_NAME
neuro acl remove-role [OPTIONS] ROLE_NAME
```

Add new role.
Remove existing role.

#### Examples

```bash
$ neuro acl add-role mycompany/subdivision
$ neuro acl remove-role mycompany/subdivision
```

#### Options
Expand All @@ -157,23 +150,30 @@ $ neuro acl add-role mycompany/subdivision



### remove-role
### revoke

Remove existing role
Revoke user access from another user


#### Usage

```bash
neuro acl remove-role [OPTIONS] ROLE_NAME
neuro acl revoke [OPTIONS] URI USER
```

Remove existing role.
Revoke user access from another user.

`URI` previously shared resource to
revoke.

`USER` to revoke `URI` resource from.

#### Examples

```bash
$ neuro acl remove-role mycompany/subdivision
$ neuro acl revoke storage:///sample_data/ alice
$ neuro acl revoke image:resnet50 bob
$ neuro acl revoke job:///my_job_id alice
```

#### Options
Expand Down
Loading