From b9a8f87616741026d8d0143ab68d18c15c8f0ed0 Mon Sep 17 00:00:00 2001 From: Corentin Mors Date: Thu, 3 Aug 2023 09:12:10 +0200 Subject: [PATCH] Improve explanation of credentials generation Fix #141 --- documentation/pages/business/index.mdx | 22 +++++++++++++++++++--- src/commands/team/credentials.ts | 2 ++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/documentation/pages/business/index.mdx b/documentation/pages/business/index.mdx index 38fd4551..6377ed1e 100644 --- a/documentation/pages/business/index.mdx +++ b/documentation/pages/business/index.mdx @@ -11,10 +11,10 @@ Commands are calling a server API to perform actions and retrieve data. The firs Needs to be authenticated as an admin to use this command. ```sh copy -dcli t generate-credentials +dcli t credentials generate ``` -You will be prompted with a list of variables to export in your environment. +You will be prompted with a list of variables to export in your environment. Simply copy/paste them in your terminal. ```sh copy export DASHLANE_TEAM_UUID=08a48d4f-[..redacted..]-fba9193d968c @@ -22,12 +22,28 @@ export DASHLANE_TEAM_ACCESS_KEY=f56[..redacted..]56ce export DASHLANE_TEAM_SECRET_KEY=839c9[..redacted..]3ada5 ``` +On Windows, you can use the `set` command instead of `export`. + +```sh copy +set DASHLANE_TEAM_UUID=08a48d4f-[..redacted..]-fba9193d968c +set DASHLANE_TEAM_ACCESS_KEY=f56[..redacted..]56ce +set DASHLANE_TEAM_SECRET_KEY=839c9[..redacted..]3ada5 +``` + Make sure you save them in a safe place (use a secure note for instance 😉). +## List credentials + +Needs to be authenticated as an admin to use this command. + +```sh copy +dcli t credentials list +``` + ## Revoke credentials Needs to be authenticated as an admin to use this command. ```sh copy -dcli t revoke-credentials +dcli t credentials revoke ``` diff --git a/src/commands/team/credentials.ts b/src/commands/team/credentials.ts index bd6c2922..23778663 100644 --- a/src/commands/team/credentials.ts +++ b/src/commands/team/credentials.ts @@ -1,3 +1,4 @@ +import winston from 'winston'; import { Command } from 'commander'; import { listAllTeamDevices } from '../../command-handlers'; import { connectAndPrepare } from '../../modules/database'; @@ -26,6 +27,7 @@ export const teamCredentialsCommands = (params: { teamGroup: Command }) => { }) ); } else { + winston.info('The credentials have been generated, run the following commands to export them:'); console.log(`export DASHLANE_TEAM_UUID=${credentials.teamUuid}`); console.log(`export DASHLANE_TEAM_ACCESS_KEY=${credentials.deviceAccessKey}`); console.log(`export DASHLANE_TEAM_SECRET_KEY=${credentials.deviceSecretKey}`);