Skip to content

Commit

Permalink
Add reference to secret in documentation (#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikescops authored Oct 17, 2023
1 parent 04e5dd2 commit 714177c
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 3 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ dcli p url,title=mywebsite
dcli note title=sample.md
# will return any secure note which matches the filters (similar to password filters)

dcli secret title=api_keys
# will return any secret which matches the filters (similar to password filters)

dcli otp [filters]
# will return any otp which matches the filters (similar to password filters)
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Card, Cards } from 'nextra-theme-docs';

![Dashlane CLI](../public/main.png)

Dashlane CLI is a command line interface for Dashlane. It allows you to interact with your Dashlane account, and to manage your passwords and personal data.
Dashlane CLI is a command line interface for Dashlane. It allows you to interact with your Dashlane account, and to manage your passwords, secure notes, secrets and personal data.

Dashlane CLI also allows you to access team admin related features such as accessing your team's member list, Dark Web Insights reports and activity logs.

Expand Down
2 changes: 1 addition & 1 deletion documentation/pages/personal/secrets/read.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ dl://<secret_identifier>[/<field>][?<transformer>]

### Secret identifier

The secret identifier is the unique identifier of the secret in your vault (it can be either a password or a secure note).
The secret identifier is the unique identifier of the secret in your vault (it can be either a content type `password`, `secure note` or `secret`).
You can get this identifier by displaying the full json of a secret with the command `dcli password <title> -o json`.

```sh
Expand Down
16 changes: 15 additions & 1 deletion documentation/pages/personal/vault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,21 @@ You can also select a different output for notes among `text, json`. The JSON op
dcli note [filters]

# Example with a JSON output
dcli note tilte=sample.md -o json
dcli note title=sample.md -o json
```

## Get a secret

Dashlane introduced the secret content type. You can use it to store any kind of secret data in your vault.

In order to get a secret, just use the `secret` command and define some filters (similarly to the secure note command).
You can also select a different output for notes among `text, json`. The JSON option outputs all the matching notes.

```sh copy
dcli secret [filters]

# Example with a JSON output
dcli secret title=api_keys -o json
```

## Options
Expand Down

0 comments on commit 714177c

Please sign in to comment.