Skip to content

Commit 28fd4ec

Browse files
author
Corentin Mors
authored
Add demo screenshots to the documentation (#174)
1 parent 5dde1fe commit 28fd4ec

14 files changed

+15
-3
lines changed

β€ŽREADME.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Documentation Website](https://img.shields.io/badge/Documentation-Website)
66
](https://dashlane.github.io/dashlane-cli)
77

8-
![Dashlane CLI Demo](./documentation/public/demo.png)
8+
![Dashlane CLI Demo](./documentation/public/main.png)
99

1010
## How to install with homebrew
1111

β€Ždocumentation/pages/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Card, Cards } from 'nextra-theme-docs';
88
<Card title="πŸ‘©β€πŸ’» Contribute on Github" href="https://github.com/Dashlane/dashlane-cli" target="_blank" />
99
</Cards>
1010

11-
![Dashlane CLI](/demo.png)
11+
![Dashlane CLI](../public/main.png)
1212

1313
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.
1414

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
import { Card, Cards } from 'nextra-theme-docs';
2+
13
# Get started with Personal Commands
24

35
Accessing your personal vault allows you to view your passwords, secure notes and OTP codes.
46

5-
import { Card, Cards } from 'nextra-theme-docs';
7+
![Dashlane CLI examples](../../public/cli-examples.png)
68

79
<Cards>
810
<Card title="πŸ”‘ Authentication" href="/personal/authentication" />
911
<Card title="πŸ”’ Accessing your vault" href="/personal/vault" />
1012
<Card title="πŸ“± Manage your devices" href="/personal/devices" />
13+
<Card title="πŸ”Ž Load your secrets" href="/personal/secrets/read" />
14+
<Card title="πŸ›Ÿ Backup your local vault" href="/personal/backup" />
1115
</Cards>

β€Ždocumentation/pages/personal/secrets/inject.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ dcli inject --in config.yaml.template --out config.yaml
4040

4141
In output file, the secret reference is replaced by the plaintext secret value.
4242

43+
![Dashlane CLI inject secret](../../../public/inject-pwd.png)
44+
4345
<Callout type="error" emoji="️🚫">
4446
Make sure to delete the resolved config file if you no longer need it.
4547
</Callout>

β€Ždocumentation/pages/personal/secrets/read.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Available transformers:
5555
- `?json=<JSONPathQuery>` to extract a value from a JSON object
5656
(please refer to [JSONPath documentation](https://github.com/JSONPath-Plus/JSONPath#syntax-through-examples) for more information)
5757

58+
![Dashlane CLI read json secret](../../../public/read-secret.png)
59+
5860
## Read a secret reference
5961

6062
You can simply use the `dcli read <path>` command to read a secret reference.
@@ -71,3 +73,5 @@ dcli read dl://<secret_identifier>/<field>?<transformer>
7173
```
7274

7375
**Note:** Accessing a secret with the secret identifier is faster than using the title of the secret as it does not require to decrypt the whole vault.
76+
77+
![Dashlane CLI read otp](../../../public/read-otp.png)

β€Ždocumentation/pages/personal/vault.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ dcli p url,title=mywebsite
2727

2828
Note: You can select a different output for passwords among `clipboard, password, json`. The JSON option outputs all the matching credentials.
2929

30+
![Dashlane CLI copy password](../../public/password-copy.png)
31+
3032
## Generate an OTP code
3133

3234
You can get an OTP code from your vault as well as the remaining time before it expires.
488 KB
Loading
56.2 KB
Loading

β€Ždocumentation/public/main.png

280 KB
Loading
33 KB
Loading

β€Ždocumentation/public/read-json.png

69.3 KB
Loading

β€Ždocumentation/public/read-otp.png

40.5 KB
Loading
38.9 KB
Loading

β€Ždocumentation/public/read-url.png

36.5 KB
Loading

0 commit comments

Comments
Β (0)