Downloads of v 1.0.0-beta:


Last Update:

26 May 2016

Package Maintainer(s):

Software Author(s):

  • David Gardiner



Run BGInfo at startup

This is a prerelease version of Run BGInfo at startup.

1.0.0-beta | Updated: 26 May 2016



Downloads of v 1.0.0-beta:



Software Author(s):

  • David Gardiner



Run BGInfo at startup 1.0.0-beta

This is a prerelease version of Run BGInfo at startup.

All Checks are Passing

2 Passing Test

Validation Testing Passed

Verification Testing Passed


To install Run BGInfo at startup, run the following command from the command line or from PowerShell:


To upgrade Run BGInfo at startup, run the following command from the command line or from PowerShell:


To uninstall Run BGInfo at startup, run the following command from the command line or from PowerShell:


NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to

4. Choose your deployment method:

choco upgrade bginfo-startup -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:

choco upgrade bginfo-startup -y --source="'STEP 3 URL'"

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0

Exit $exitCode

- name: Ensure bginfo-startup installed
    name: bginfo-startup
    state: present
    version: 1.0.0-beta
    source: STEP 3 URL

See docs at

chocolatey_package 'bginfo-startup' do
  action    :install
  version  '1.0.0-beta'
  source   'STEP 3 URL'

See docs at

    Name: bginfo-startup,
    Version: 1.0.0-beta,
    Source: STEP 3 URL

Requires Otter Chocolatey Extension. See docs at

cChocoPackageInstaller bginfo-startup
   Name     = 'bginfo-startup'
   Ensure   = 'Present'
   Version  = '1.0.0-beta'
   Source   = 'STEP 3 URL'

Requires cChoco DSC Resource. See docs at

package { 'bginfo-startup':
  provider => 'chocolatey',
  ensure   => '1.0.0-beta',
  source   => 'STEP 3 URL',

Requires Puppet Chocolatey Provider module. See docs at

salt '*' chocolatey.install bginfo-startup version="1.0.0-beta" source="STEP 3 URL"

See docs at

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package is exempt from moderation. While it is likely safe for you, there is more risk involved.

Installs a custom.bgi file and creates a shortcut in the StartUp folder so that bginfo.exe will be run on user login.

Package Parameters

The following package parameters can be set:

  • /RunImmediately - run BGInfo using the custom.bgi file immediately (rather than waiting until next user login)

These parameters can be passed to the installer with the use of --params.
For example: --params '"/RunImmediately"'.

    [switch] $RunImmediately

$ErrorActionPreference = 'Stop'; # stop on all errors

$packageName= 'chocolatey-bginfo-startup' # arbitrary name for the package, used in messages
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

$arguments = @{}
$packageParameters = $env:chocolateyPackageParameters

# Now parse the packageParameters using good old regular expression
if ($packageParameters) {
    $match_pattern = "\/(?<option>([a-zA-Z]+)):(?<value>([`"'])?([a-zA-Z0-9- _\\:\.]+)([`"'])?)|\/(?<option>([a-zA-Z]+))"
    $option_name = 'option'
    $value_name = 'value'

    if ($packageParameters -match $match_pattern ){
        $results = $packageParameters | Select-String $match_pattern -AllMatches
        $results.matches | % {
        Throw "Package Parameters were found but were invalid (REGEX Failure)"

    if ($arguments.ContainsKey("RunImmediately")) {
        Write-Verbose "You want to run bginfo"
        $RunImmediately = [switch]::Present
} else {
    Write-Debug "No Package Parameters Passed in"

# Copy custom.bgi if it doesn't already exist
if (-not (Test-Path "c:\ProgramData\SysInternals\BGInfo\custom.bgi"))
    if (-not (Test-Path "c:\ProgramData\SysInternals\BGInfo"))
        New-Item "c:\ProgramData\SysInternals\BGInfo" -ItemType Container | Out-Null

    Copy-Item -Path "$toolsDir\custom.bgi" -Destination "c:\ProgramData\SysInternals\BGInfo\custom.bgi"

Install-ChocolateyShortcut -shortcutFilePath "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup\bginfo.lnk" -targetPath "C:\ProgramData\chocolatey\bin\Bginfo.exe" -arguments "c:\ProgramData\SysInternals\BGInfo\custom.bgi /nolicprompt /timer:0" -description "Launch bginfo silently and use custom.bgi"

if ($RunImmediately.IsPresent)
    & "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup\bginfo.lnk"
$ErrorActionPreference = 'Stop'; # stop on all errors

$packageName = 'chocolatey-bginfo-startup'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

# Remove shortcut
if (Test-Path "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup\bginfo.lnk")
    Remove-Item "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup\bginfo.lnk" -ErrorAction Ignore -Force

# Only remove bgi file if it is unmodified
$packageDate = (Get-Item "$toolsDir\custom.bgi").LastWriteTimeUtc
$installedDate = (Get-Item "c:\ProgramData\SysInternals\BGInfo\custom.bgi").LastWriteTimeUtc

if ($packageDate -eq $installedDate)
    Remove-Item "c:\ProgramData\SysInternals\BGInfo\custom.bgi"

    # Remove directories only if they are empty
    if ((Get-ChildItem "c:\ProgramData\SysInternals\BGInfo" -Force | Measure-Object).Count -eq 0)
        Remove-Item "c:\ProgramData\SysInternals\BGInfo"

        if ((Get-ChildItem "c:\ProgramData\SysInternals" -Force | Measure-Object).Count -eq 0)
        Remove-Item "c:\ProgramData\SysInternals"

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Run BGInfo at startup 1.0.0-beta 628 Thursday, May 26, 2016 Exempted

Discussion for the Run BGInfo at startup Package

Ground Rules:

  • This discussion is only about Run BGInfo at startup and the Run BGInfo at startup package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Run BGInfo at startup, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus