Skip to content

Commit 280573e

Browse files
author
Corentin Mors
authored
Cleanup documentation with latest changes (#228)
This is a cleanup for the documentation with some missing additions.
1 parent f2d8e3a commit 280573e

File tree

10 files changed

+92
-70
lines changed

10 files changed

+92
-70
lines changed

documentation/pages/business/index.mdx

+6-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ import { Callout } from 'nextra/components';
44

55
Commands related to business use a different authentication than your personal vault.
66

7-
Commands are calling a server API to perform actions and retrieve data. The first step is to login with the personal account ([follow this guide](/personal/authentication)) of a team admin and to generate a set of credentials.
7+
Commands are calling a server API to perform actions and retrieve data.
8+
The first step is to login with the personal account ([follow this guide](../personal/authentication.mdx)) of a team admin and to generate a set of credentials.
89

910
## Generate credentials
1011

11-
<Callout emoji="💡">Needs to be authenticated as an admin to use this command.</Callout>
12+
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
1213

1314
```sh copy
1415
dcli t credentials generate
@@ -28,19 +29,19 @@ set DASHLANE_TEAM_DEVICE_KEYS=dlt_[deviceAccessKey]_[payload]
2829

2930
Make sure you save them in a safe place (use a secure note for instance 😉).
3031

31-
<Callout emoji="ℹ️">The token you'll get is starting by `dlt` in order to be easily identified by scanning tools.</Callout>
32+
<Callout type="info">The token you'll get is starting by `dlt` in order to be easily identified by scanning tools.</Callout>
3233

3334
## List credentials
3435

35-
<Callout emoji="💡">Needs to be authenticated as an admin to use this command.</Callout>
36+
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
3637

3738
```sh copy
3839
dcli t credentials list
3940
```
4041

4142
## Revoke credentials
4243

43-
<Callout emoji="💡">Needs to be authenticated as an admin to use this command.</Callout>
44+
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
4445

4546
```sh copy
4647
dcli t credentials revoke <DASHLANE_TEAM_ACCESS_KEY>

documentation/pages/business/members.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Callout } from 'nextra/components';
22

33
# Listing members
44

5-
<Callout emoji="💡">Needs team credentials to use this command.</Callout>
5+
<Callout>Needs team credentials to use this command.</Callout>
66

77
## Fetching the list of members
88

documentation/pages/install.mdx

+36-28
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
import { Tab, Tabs } from 'nextra-theme-docs'
1+
import { Callout, Tab, Tabs } from 'nextra-theme-docs'
22

33
# Install
44

5-
The Dashlane CLI can be installed in multiple ways. You can either install it using [Homebrew](https://brew.sh/) on **macOS** and **Linux**, manually with [Yarn](https://yarnpkg.com/) or download the packaged executables for **Windows**, **macOS** and **Linux** on x64 architectures.
5+
The Dashlane CLI can be installed in multiple ways.
66

7-
<Tabs items={['Homebrew', 'Manually with Yarn', 'Packaged Executables (x64 only)']}>
7+
You can either install it using :
8+
9+
- [Homebrew](https://brew.sh/) on **macOS** and **Linux**
10+
- download the packaged executables for **Windows**, **macOS** and **Linux** on x64 architectures.
11+
- manually with [Yarn](https://yarnpkg.com/)
12+
13+
<Tabs items={['Homebrew', 'Packaged Executables (x64 only)', 'Manually with Yarn']}>
814
<Tab>
915
You can install the Dashlane CLI using [Homebrew](https://brew.sh/), a package manager for __macOS__ and __Linux__.
1016

@@ -23,31 +29,6 @@ The Dashlane CLI can be installed in multiple ways. You can either install it us
2329
The CLI is now installed on your machine, it will be updated automatically when a new version is released.
2430
</Tab>
2531
<Tab>
26-
This method is available on every environment that supports [Node.js](https://nodejs.org/en/) and Yarn.
27-
28-
First you need to download or `git clone` this repository and run the following commands in the root directory of the repository.
29-
30-
Install the dependencies:
31-
32-
```sh copy
33-
yarn
34-
```
35-
36-
In order to build:
37-
38-
```sh copy
39-
yarn run build
40-
```
41-
42-
In order to link:
43-
44-
```sh copy
45-
yarn link
46-
```
47-
48-
Make sure to pull the latest changes and rebuild the project to get the latest version of the CLI.
49-
</Tab>
50-
<Tab>
5132
Head to the [releases page](https://github.com/Dashlane/dashlane-cli/releases) and download the latest version of the CLI for your platform (Windows, macOS or Linux).
5233

5334
You may need to mark the binary as executable (on macOS and Linux):
@@ -80,6 +61,33 @@ The Dashlane CLI can be installed in multiple ways. You can either install it us
8061

8162
You will need to get the latest version of the CLI manually by downloading the latest release and replacing the binary in your bin folder.
8263
</Tab>
64+
<Tab>
65+
<Callout type="warning">We do not recommend the manual install for personal computers, if you plan to use the local keychain, as the NodeJS process will be the owner of your secrets, we recommend to use a packaged version.</Callout>
66+
67+
This method is available on every environment that supports [Node.js](https://nodejs.org/en/) and Yarn.
68+
69+
First you need to download or `git clone` this repository and run the following commands in the root directory of the repository.
70+
71+
Install the dependencies:
72+
73+
```sh copy
74+
yarn
75+
```
76+
77+
In order to build:
78+
79+
```sh copy
80+
yarn run build
81+
```
82+
83+
In order to link:
84+
85+
```sh copy
86+
npm link
87+
```
88+
89+
Make sure to pull the latest changes and rebuild the project to get the latest version of the CLI.
90+
</Tab>
8391

8492
</Tabs>
8593

documentation/pages/logout.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ If you want to start fresh with the CLI or use another account, you can logout a
88
dcli logout
99
```
1010

11-
<Callout type="info" emoji="ℹ️">
12-
This does not perform an account reset, it only resets the local data on the device.
13-
</Callout>
11+
<Callout type="info">This does not perform an account reset, it only resets the local data on the device.</Callout>
1412

1513
A confirmation will be asked, then the local database containing your encrypted data will be wiped and any entry related to the CLI will be removed from the OS keychain.

documentation/pages/personal/authentication.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You will be then asked to validate a second factor to register the CLI to your a
1616
- Master Password
1717
- SSO (self-hosted only)
1818

19-
<Callout type="warning" emoji="⚠️">
19+
<Callout type="warning">
2020
Confidential SSO (using Nitro Enclaves) and Password-Less authentication are not supported yet.
2121
</Callout>
2222

documentation/pages/personal/backup.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ The command will perform a sync prior to the backup to ensure that the latest da
55

66
The backup is a [sqlite3](https://www.sqlite.org/index.html) database file containing all your secrets encrypted by your master password.
77

8-
```bash
9-
# By default the backup file is stored in the current directory and named dashlane-backup-<timestamp>.db
8+
```sh copy filename="By default the backup file is stored in the current directory and named dashlane-backup-<timestamp>.db"
109
dcli backup
10+
```
1111

12-
# You can specify the directory and filename
12+
```sh copy filename="You can specify the directory and filename"
1313
dcli backup --filename <filename> --directory <directory>
1414
```
1515

documentation/pages/personal/devices.mdx

+6-4
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ dcli devices remove --others
4646
dcli devices remove --all
4747
```
4848

49-
<Callout type="info" emoji="ℹ️">
49+
<Callout type="info">
5050
If you remove the current CLI device, you will need to do a `dcli logout` in order to re-authenticate.
5151
</Callout>
5252

@@ -64,7 +64,7 @@ This will create a new device named `my_server` and will print the device creden
6464
Save them in a safe place (like in a secure note), as you won't be able to retrieve them later.
6565
Run the suggested commands on your target device (your server or CI) to set the device credentials as environment variables.
6666

67-
```sh
67+
```sh
6868
export DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
6969
```
7070

@@ -74,9 +74,11 @@ On Windows, you can use the `set` command instead of `export`.
7474
set DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
7575
```
7676

77-
<Callout emoji="ℹ️">The token you'll get is starting by `dls` in order to be easily identified by scanning tools.</Callout>
77+
<Callout type="info">
78+
The token you'll get is starting by `dls` in order to be easily identified by scanning tools.
79+
</Callout>
7880

79-
<Callout type="warning" emoji="⚠️">
81+
<Callout type="warning">
8082
OTP at each login and SSO are not supported for non-interactive devices. We recommend creating a dedicated Dashlane
8183
account for your non-interactive devices.
8284
</Callout>

documentation/pages/personal/secrets/inject.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ In output file, the secret reference is replaced by the plaintext secret value.
4242

4343
![Dashlane CLI inject secret](../../../public/inject-pwd.png)
4444

45-
<Callout type="error" emoji="️🚫">
46-
Make sure to delete the resolved config file if you no longer need it.
47-
</Callout>
45+
<Callout type="error">Make sure to delete the resolved config file if you no longer need it.</Callout>
4846

4947
</Steps>

documentation/pages/personal/secrets/read.mdx

+5-4
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,15 @@ Available transformers:
6161

6262
You can simply use the `dcli read <path>` command to read a secret reference.
6363

64-
```sh
65-
# Read the whole secret
64+
```sh copy filename="Read the whole secret"
6665
dcli read dl://<secret_identifier>
66+
```
6767

68-
# Read a specific field of the secret
68+
```sh copy filename="Read a specific field of the secret"
6969
dcli read dl://<secret_identifier>/<field>
70+
```
7071

71-
# Read a specific field of the secret and apply a transformer
72+
```sh copy filename="Read a specific field of the secret and apply a transformer"
7273
dcli read dl://<secret_identifier>/<field>?<transformer>
7374
```
7475

documentation/pages/personal/vault.mdx

+32-18
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,62 @@ import { YoutubePlayer } from '../../components/player';
33

44
# Accessing your Vault
55

6-
<Callout type="info" emoji="ℹ️">
7-
For now accessing your vault is read only.
8-
</Callout>
6+
<Callout type="info">For now accessing your vault is read only.</Callout>
97

108
## Get a password
119

1210
<YoutubePlayer videoId="dMII21YI5s4" />
1311

14-
```sh
12+
```sh copy filename="Return any entry for which either the url or the title matches mywebsite"
1513
dcli p mywebsite
16-
# will return any entry for which either the url or the title matches mywebsite
14+
```
1715

16+
```sh copy filename="Copy the login of the selected entry for which either the url or the title matches mywebsite to the clipboard"
1817
dcli p mywebsite -f login
19-
# will copy the login of the selected entry for which either the url or the title matches mywebsite to the clipboard
18+
```
2019

20+
```sh copy filename="Print the email of the selected entry for which either the url or the title matches mywebsite to the console"
2121
dcli p mywebsite -f email -o console
22-
# will print the email of the selected entry for which either the url or the title matches mywebsite to the console
22+
```
2323

24+
```sh copy filename="Print the json of the entry for which either the url or the title matches mywebsite to the console"
2425
dcli p mywebsite -o json
25-
# will print the json of the entry for which either the url or the title matches mywebsite to the console
26+
```
2627

28+
```sh copy filename="Return any entry for which the id matches xxxxxx"
2729
dcli p id=xxxxxx
28-
# will return any entry for which the id matches xxxxxx
30+
```
2931

32+
```sh copy filename="Return any entry for which the url matches someurl, or the title matches mytitle"
3033
dcli p url=someurl title=mytitle
31-
# will return any entry for which the url matches someurl, or the title matches mytitle
34+
```
3235

36+
```sh copy filename="Return any entry for which either the url or the title matches mywebsite"
3337
dcli p url,title=mywebsite
34-
# will return any entry for which either the url or the title matches mywebsite
3538
```
3639

37-
Note: You can select a different output for passwords among `clipboard, password, json`. The JSON option outputs all the matching credentials.
40+
**Note:** You can select a different output for passwords among `clipboard, console, json`. The JSON option outputs all the matching credentials.
3841

3942
![Dashlane CLI copy password](../../public/password-copy.png)
4043

41-
## Generate an OTP code
44+
### Get the email or login of a password
45+
46+
You can get the email or username of a password by using the `--field` or `-f` parameter:
47+
48+
```sh copy
49+
dcli password -f email mywebsite
50+
```
51+
52+
```sh copy
53+
dcli password -f login mywebsite
54+
```
55+
56+
### Generate an OTP code
4257

4358
You can get an OTP code from your vault as well as the remaining time before it expires.
44-
Just use the `otp` or `o` command and filter similarly to the password command:
4559

4660
```sh copy
47-
dcli otp [filters]
61+
dcli password -f otp mywebsite
4862
```
4963

5064
## Get a secure note
@@ -70,8 +84,9 @@ You can also select a different output for notes among `text, json`. The JSON op
7084

7185
```sh copy
7286
dcli secret [filters]
87+
```
7388

74-
# Example with a JSON output
89+
```sh copy filename="Example: get the secret with the title api_keys and a JSON output"
7590
dcli secret title=api_keys -o json
7691
```
7792

@@ -93,8 +108,7 @@ This could be useful if you want to share SSH keys with your team.
93108

94109
Let's say you have generated a new SSH key pair and you want to store it in Dashlane.
95110

96-
```sh
97-
# this is an example, use the parameters you want
111+
```sh copy filename="This is an example, use the parameters you want"
98112
ssh-keygen -t rsa -b 4096 -C "Dashlane SSH demo key"
99113
```
100114

0 commit comments

Comments
 (0)