From b9dd19bebf095f77d378cd6d30b24adf6e627eaf Mon Sep 17 00:00:00 2001 From: Corentin Mors Date: Tue, 17 Oct 2023 09:36:11 +0200 Subject: [PATCH] Add reference to secret in documentation --- README.md | 3 +++ documentation/pages/index.mdx | 2 +- documentation/pages/personal/secrets/read.mdx | 2 +- documentation/pages/personal/vault.mdx | 16 +++++++++++++++- 4 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c3b43a04..ef373633 100644 --- a/README.md +++ b/README.md @@ -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) ``` diff --git a/documentation/pages/index.mdx b/documentation/pages/index.mdx index 928ca8b2..abf4add2 100644 --- a/documentation/pages/index.mdx +++ b/documentation/pages/index.mdx @@ -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. diff --git a/documentation/pages/personal/secrets/read.mdx b/documentation/pages/personal/secrets/read.mdx index 484ceb15..ecfbe32e 100644 --- a/documentation/pages/personal/secrets/read.mdx +++ b/documentation/pages/personal/secrets/read.mdx @@ -23,7 +23,7 @@ dl://[/][?] ### 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 -o json`. ```sh diff --git a/documentation/pages/personal/vault.mdx b/documentation/pages/personal/vault.mdx index 5ffd902c..97b8f0c7 100644 --- a/documentation/pages/personal/vault.mdx +++ b/documentation/pages/personal/vault.mdx @@ -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