Skip to content

Commit

Permalink
GitBook: [#7] No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
@anagoessens @gitbook-bot
anagoessens authored and gitbook-bot committed Apr 4, 2022
1 parent 7e25330 commit 487daf5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
## Features

* [Introduction](features/introduction.md)
* [Connections](features/connections.md)
* [Connection](features/connections.md)
* [Credential Definitions](features/credential-definitions.md)
* [Credentials](features/credentials.md)
* [Schema's](features/schemas.md)
Expand Down
36 changes: 17 additions & 19 deletions docs/features/connections.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
description: Retrieve connections or create invitations
---

# Connections
# Connection

Aries CLI offers various methods to create and receive invitations.

### Usage

```
aries-cli connections [OPTIONS] [SUBCOMMAND]
aries-cli connection [OPTIONS] [SUBCOMMAND]
```

#### Options
Expand All @@ -27,41 +27,39 @@ aries-cli connections [OPTIONS] [SUBCOMMAND]
| invite | Create a new connection invitation |
| receive | Receive an invitation by url |



### Create an Invitation

Create a new connection invitation.

```
aries-cli connections invite [OPTIONS]
aries-cli connection invite [OPTIONS]
```

#### Available flags

| Alias | Flag | Description |
| ----- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -a | --auto-accept | Automatically accept the new connection once they accept this invitation |
| -h | --help | Print help information |
| -l | --alias \<ALIAS> | The name a new connection will use to identify itself |
| -m | --multi-use | This invitation can be used more than once |
| -q | --qr | Print a QR code, convenient for use with mobile apps |
| -t | --toolbox | <p>Short-hand to create an invitation for the Aries Toolbox that sets: </p><ul><li>alias="toolbox"</li><li>multi-use="false"</li><li>auto-accept="true" </li></ul><p>and gives admin rights over the invitation to the toolbox</p> |
| Alias | Flag | Description |
| ----- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -a | --auto-accept | Automatically accept the new connection once they accept this invitation |
| -h | --help | Print help information |
| -l | --alias \<ALIAS> | The name a new connection will use to identify itself |
| -m | --multi-use | This invitation can be used more than once |
| -q | --qr | Print a QR code, convenient for use with mobile apps |
| -t | --toolbox | <p>Short-hand to create an invitation for the Aries Toolbox that sets:</p><ul><li>alias="toolbox"</li><li>multi-use="false"</li><li>auto-accept="true"</li></ul><p>and gives admin rights over the invitation to the toolbox</p> |

#### Example usage

Create an invitation that can be used more than once and is auto accepted. The `-c` flag automatically copies the invitation url to your clipboard.
Create an invitation that can be used more than once and is auto accepted. The `-c` flag automatically copies the invitation URL to your clipboard.

```
aries-cli -c connections invite -m -a
aries-cli -c connection invite -m -a
```

### Receive an invitation

Receive an invitation by url.
Receive an invitation by URL.

```
aries-cli connections receive --url <URL>
aries-cli connection receive --url <URL>
```

#### Available flags
Expand All @@ -73,8 +71,8 @@ aries-cli connections receive --url <URL>

#### Example usage

Supply an invitation url to accept.
Supply an invitation URL to accept.

```
aries-cli connections receive https://didcomm.agent.community.animo.id?c_i=eyJAdHlwZSI6ICJkaWQ6c292OkJ6Q2JzTlloTXJqSGlxWkRUVUFTSGc7c3BlYy9jb25uZWN0aW9ucy8xLjAvaW52aXRhdGlvbiIsICJAaWQiOiAiMjNiOGY0ZDAtNzIyNi00ZmQ0LWEyNDAtMjJkNDgxNTViODBlIiwgInJlY2lwaWVudEtleXMiOiBbIjZZVVU2dnp2b0hTV29OWlRDUGE1eFlYV3kyUGJ5VGREcnVKa0VMRXR4NW9kIl0sICJsYWJlbCI6ICJBbmltbyBDb21tdW5pdHkgQWdlbnQiLCAic2VydmljZUVuZHBvaW50IjogImh0dHBzOi8vZGlkY29tbS5hZ2VudC5jb21tdW5pdHkuYW5pbW8uaWQifQ==
aries-cli connection receive https://didcomm.agent.community.animo.id?c_i=eyJAdHlwZSI6ICJkaWQ6c292OkJ6Q2JzTlloTXJqSGlxWkRUVUFTSGc7c3BlYy9jb25uZWN0aW9ucy8xLjAvaW52aXRhdGlvbiIsICJAaWQiOiAiMjNiOGY0ZDAtNzIyNi00ZmQ0LWEyNDAtMjJkNDgxNTViODBlIiwgInJlY2lwaWVudEtleXMiOiBbIjZZVVU2dnp2b0hTV29OWlRDUGE1eFlYV3kyUGJ5VGREcnVKa0VMRXR4NW9kIl0sICJsYWJlbCI6ICJBbmltbyBDb21tdW5pdHkgQWdlbnQiLCAic2VydmljZUVuZHBvaW50IjogImh0dHBzOi8vZGlkY29tbS5hZ2VudC5jb21tdW5pdHkuYW5pbW8uaWQifQ==
```

0 comments on commit 487daf5

Please sign in to comment.