Skip to content

(#1074) Add docs for Get-ChocolateyConfigValue #1174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
description: Information on Get-ChocolateyConfigValue function
external help file: Chocolatey.PowerShell.dll-Help.xml
Module Name: Chocolatey.PowerShell
online version:
order: 30
schema: 2.0.0
title: Get-ChocolateyConfigValue
xref: get-chocolateyconfigvalue
---
import Xref from '@components/Xref.astro';

# Get-ChocolateyConfigValue

## SYNOPSIS
Retrieves a named configuration value from the Chocolatey Configuration file.

## SYNTAX

```
Get-ChocolateyConfigValue -Name <String> [-IgnoredArguments <Object[]>] [<CommonParameters>]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an alias for -ConfigKey, as this is what the previous version of -Name was.

NOTE: I haven't got to the other PR yet 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind, I can see this in play in the example below.

```

## DESCRIPTION
This cmdlet will retrieve the configuration value specified by the `-Name` parameter from the Chocolatey configuration file.
Sensitive configuration values (for example: `proxyPassword`) will remain in encrypted form when retrieved.

Configuration entries are retrieved by case-insensitive comparison of the name (`key` attribute) in the configuration file.

## EXAMPLES

### Example 1
```powershell
PS C:\> Get-ChocolateyConfigValue -Name cacheLocation
```

Outputs the cacheLocation from the Chocolatey configuration file.

### Example 2
```powershell
PS C:\> Get-ChocolateyConfigValue -ConfigKey cacheLocation
```

Outputs the cacheLocation from the Chocolatey configuration file.

## PARAMETERS

### -IgnoredArguments
Allows splatting with arguments that do not apply. Do not use directly.

```yaml
Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
The name of the configuration value to retrieve.

```yaml
Type: String
Parameter Sets: (All)
Aliases: ConfigKey

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## OUTPUTS

### System.String

## NOTES

Available in 2.1.0+
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated, right?


## RELATED LINKS

<Xref title="Cmdlet Reference" value="powershell-cmdlet-reference" />

<Xref title="Function Reference" value="powershell-reference" />
2 changes: 1 addition & 1 deletion src/content/docs/en-us/create/cmdlets/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Keep in mind Chocolatey's automation scripts are just PowerShell, so you can do

## Complete List (alphabetical order)

* <Xref title="Get-ChocolateyConfigValue" value="get-chocolateyconfigvalue" />
* <Xref title="Get-EnvironmentVariable" value="get-environmentvariable" />
* <Xref title="Get-EnvironmentVariableNames" value="get-environmentvariablenames" />
* <Xref title="Install-ChocolateyPath" value="get-environmentvariable" />
* <Xref title="Set-EnvironmentVariable" value="set-environmentvariable" />
* <Xref title="Test-ProcessAdminRights" value="test-processadminrights" />
* <Xref title="Uninstall-ChocolateyPath" value="uninstall-chocolateypath" />
* <Xref title="Update-SessionEnvironment" value="update-sessionenvironment" />

This file was deleted.