Skip to content
Merged
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
37eea4f
Merge pull request #154 from quixio/dev
SteveRosam May 19, 2023
207294f
Merge pull request #156 from quixio/dev
srosam May 19, 2023
51fe231
Docs Release 2023-05-004
SteveRosam May 23, 2023
214bdbb
Merge pull request #164 from quixio/dev
tbedford Jun 1, 2023
bf52383
Merge pull request #172 from quixio/dev
tbedford Jun 12, 2023
2f909f5
Merge pull request #176 from quixio/dev
tbedford Jun 30, 2023
ef2f237
Merge pull request #177 from quixio/dev
tbedford Jul 4, 2023
b176521
Merge pull request #182 from quixio/dev
tbedford Jul 10, 2023
048a392
Merge pull request #187 from quixio/dev
tbedford Sep 26, 2023
d7954fd
Merge pull request #189 from quixio/dev
tbedford Sep 29, 2023
772026b
Merge pull request #192 from quixio/dev
tbedford Oct 11, 2023
44607d4
Merge pull request #195 from quixio/dev
tbedford Oct 13, 2023
d4df211
Merge pull request #199 from quixio/dev
tbedford Oct 18, 2023
d240e38
Merge pull request #203 from quixio/dev
tbedford Oct 19, 2023
fc4af7d
Merge pull request #205 from quixio/dev
SteveRosam Oct 19, 2023
982e466
Merge pull request #207 from quixio/dev
tbedford Oct 23, 2023
151de94
Merge pull request #210 from quixio/dev
tbedford Oct 26, 2023
666ead4
Merge pull request #212 from quixio/dev
tbedford Oct 30, 2023
484aa47
Merge pull request #214 from quixio/dev
tbedford Nov 7, 2023
50a2d2a
Merge pull request #222 from quixio/dev
tbedford Nov 9, 2023
0e96559
Merge pull request #227 from quixio/dev
tbedford Nov 17, 2023
6155e09
Merge pull request #230 from quixio/dev
tbedford Nov 28, 2023
7b4cf31
Merge pull request #232 from quixio/dev
tbedford Dec 6, 2023
a951bb5
Merge pull request #239 from quixio/dev
SteveRosam Jan 11, 2024
1acf195
Update cli.md
luisquix Jan 15, 2024
11ebfa8
More detailed role explanation
luisquix Jan 15, 2024
06cb491
Shorten role descriptions
luisquix Jan 15, 2024
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
29 changes: 15 additions & 14 deletions docs/get-started/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ There are two ways to obtain this:
Run the following command:

```
quix workspaces get
quix workspaces list
```

This lists all workspaces in the organization, and displays the workspace ID, along with the following:
Expand Down Expand Up @@ -112,7 +112,7 @@ quix command [subcommand] [options]
To list all your deployments you would use:

```
quix deployments get --workspaceId your-workspace-id
quix deployments list your-workspace-id
```

The information returned includes:
Expand All @@ -130,15 +130,15 @@ The information returned includes:
To list all your applications (in your environment):

```
quix applications get your-workspace-id
quix applications list your-workspace-id
```

## Obtaining output in JSON format

You can return your results as JSON, rather than in tabular form. For example, to return a list of topics in an environment in JSON format:

```
quix topic get your-workspace-id --output json
quix topics list your-workspace-id --output json
```

With some practice, you will find the usage follows a similar pattern for most commands.
Expand Down Expand Up @@ -168,7 +168,7 @@ quix contexts use byoc
To list your available contexts, use the following:

```
quix contexts get
quix contexts list
```

## Managing permissions
Expand All @@ -189,10 +189,11 @@ Scope is hierarchical. For example, if you assign a user a role at the `Organisa

Role can be one of:

* Admin - complete control
* Editor - sync, permissions, logs, start/stop deployments
* Viewer - view only

* `Admin` - complete control
* `Manager` - complete control except editing users, billing and organisation
* `Editor` - same as `Manager` without permissions of create or delete Repositories and Workspaces
* `Viewer` - read only permissions

Roles are assigned to specific users.

### Users
Expand All @@ -216,13 +217,13 @@ This returns your:
To obtain a complete list of users in an organization, use the following command:

```
quix users get
quix users list
```

To narrow down the returned list:

```
quix users get | grep tony
quix users list | grep tony
```

This returns:
Expand All @@ -240,13 +241,13 @@ You can also use the CLI to explore permissions.
To get a complete list of users and their permissions:

```
quix permissions get
quix permissions list
```

You can reduce the list using:

```
quix permissions get | grep tony
quix permissions list | grep tony
```

This returns:
Expand Down Expand Up @@ -324,7 +325,7 @@ This sets the following permissions for the specified repository and workspace:

!!! tip

Repository IDs can be found by typing `quix repositories get`.
Repository IDs can be found by typing `quix repositories list`.



Expand Down