From 67058d8b553974e3d226359456cacfba31587ef6 Mon Sep 17 00:00:00 2001 From: = Date: Tue, 15 Oct 2024 01:49:38 +0530 Subject: [PATCH] feat: updated cli docs --- docs/integrations/platforms/infisical-agent.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/integrations/platforms/infisical-agent.mdx b/docs/integrations/platforms/infisical-agent.mdx index 61e6f41ca..ba8d04763 100644 --- a/docs/integrations/platforms/infisical-agent.mdx +++ b/docs/integrations/platforms/infisical-agent.mdx @@ -312,10 +312,10 @@ infisical agent --config example-agent-config-file.yaml ```bash - listSecrets "" "environment-slug" "" + listSecrets "" "environment-slug" "" "" ``` ```bash example-template-usage - {{- with listSecrets "6553ccb2b7da580d7f6e7260" "dev" "/" }} + {{- with listSecrets "6553ccb2b7da580d7f6e7260" "dev" "/" `{"recursive": false, "expandSecretReferences": true}` }} {{- range . }} {{ .Key }}={{ .Value }} {{- end }} @@ -324,9 +324,12 @@ infisical agent --config example-agent-config-file.yaml **Function name**: listSecrets -**Description**: This function can be used to render the full list of secrets within a given project, environment and secret path. +**Description**: This function can be used to render the full list of secrets within a given project, environment and secret path. -**Returns**: A single secret object with the following keys `Key, WorkspaceId, Value, Type, ID, and Comment` +An optional JSON argument is also available. It includes the properties `recursive`, which defaults to false, and `expandSecretReferences`, which defaults to true and expands the returned + + +**Returns**: A single secret object with the following keys `Key, WorkspaceId, Value, SecretPath, Type, ID, and Comment`