Downloads:
1,044,936
Downloads of v 0.0.3.1:
301
Last Update:
07 Jun 2018
Package Maintainer(s):
Software Author(s):
- bcurran3
Tags:
bcurran3 unofficial choco cleaner cleanup schtasks scheduled task- Software Specific:
- Software Site
- Software Source
- Software License
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
(unofficial) Choco Cleaner (Script + Task)
This is not the latest version of (unofficial) Choco Cleaner (Script + Task) available.
- 1
- 2
- 3
0.0.3.1 | Updated: 07 Jun 2018
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
1,044,936
Downloads of v 0.0.3.1:
301
Maintainer(s):
Software Author(s):
- bcurran3
(unofficial) Choco Cleaner (Script + Task) 0.0.3.1
This is not the latest version of (unofficial) Choco Cleaner (Script + Task) available.
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install (unofficial) Choco Cleaner (Script + Task), run the following command from the command line or from PowerShell:
To upgrade (unofficial) Choco Cleaner (Script + Task), run the following command from the command line or from PowerShell:
To uninstall (unofficial) Choco Cleaner (Script + Task), run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
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 https://community.chocolatey.org/api/v2/. 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
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download choco-cleaner --internalize --version=0.0.3.1 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade choco-cleaner -y --source="'INTERNAL REPO URL'" --version="'0.0.3.1'" [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 choco-cleaner -y --source="'INTERNAL REPO URL'" --version="'0.0.3.1'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install choco-cleaner
win_chocolatey:
name: choco-cleaner
version: '0.0.3.1'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'choco-cleaner' do
action :install
source 'INTERNAL REPO URL'
version '0.0.3.1'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller choco-cleaner
{
Name = "choco-cleaner"
Version = "0.0.3.1"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'choco-cleaner':
ensure => '0.0.3.1',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved by moderator flcdrg on 17 Jun 2018.
DO YOU WANT TO RECOVER SOME DISK SPACE USED BY UNNECESSARY RESIDUAL CHOCOLATEY FILES?
YOU JUST FOUND THE EASY WAY!
This package creates a Windows Scheduled Task to run choco-cleaner.ps1 every Sunday at 11:00 PM.
BEFORE and AFTER choco-cleaner: (198 packages installed and does not include temp folder deletions.)
Sure, you're probably not going to get gigabytes of space back, but every few KB matters on some computers and to some people! Due to slack space small files such as 6 byte .ignore files actually take up 4 KB of HDD space each.
FEATURES:
Set it and forget it! choco-cleaner cleans up your Chocolatey installation every Sunday at 11 PM in the background so you don't have to be bothered with it.
choco-cleaner is completely configurable, just edit \ProgramData\chocolatey\bin\choco-cleaner.xml and set true/false for any grouping of file types you want to delete or not. License and log files default to false. This has been mandated to me for passing moderation. Everything else listed below is deleted by default.
choco-cleaner deletes:
- .log files that are not the most current one (NOT default)
- .zip, .rar, .iso, and various archive files left over from packages that forgot to delete them post install
- .zip.txt and other archive-extensions.txt are lists of files that were extracted from an archive file for installation
- .msi, .msu, and .msp are Microsoft intall packages left over from packages that forgot to delete them post install
- .ignore files that are created to not shim executables during package install but not needed after shim operations are finished (This may change in a future version of Chocolatey.)
- credits.txt are program credits (of contributors) files you can read on the web
- readme.txt files you can read on the web
- .md files are usually markdown readme files that you can read on the web
- .old files are Chocolatey files that have been replaced by newer versions (exe's and dll's mostly)
- chocolatey.config.backup is a backup of your chocolatey.config file
- _processed.txt - I have no idea what made this file or why it exists
- lib-bad holds packages that failed to install and lib-bkp contains aborted packages (during updates?)
- archives and executables out of .nuspkg files which are ZIP archives with NuGet package information - this is similar to what Package Reducer does
- \Users\username\AppData\Local\Temp\chocolatey is where new package files are downloaded to during pre-installation (if you haven't changed your cacheLocation in chocolatey.config))
- \Windows\Temp\chocolatey
- license.txt and verification.txt files are included when packages include binaries, you can read them on the package web page, programname.license.txt files are license files for Chocolatey default tools (NOT default)
INSTRUCTIONS:
To manually run choco-cleaner:
- Command Prompt: \ProgramData\chocolatey\lib\choco-cleaner\tools\choco-cleaner-manual.bat
- PowerShell: \ProgramData\chocolatey\bin\choco-cleaner.ps1
- Windows Start Menu: click the icon. If you have choco-shortcuts-winconfig installed you'll find it with the rest of the Chocolatey Shortcuts.
@echo off
net session >nul 2>&1
if %errorLevel% == 0 goto RunScript
else (
color 4e
cls
echo.
echo ********************************************
echo * You must choose "Run as administrator" *
echo ********************************************
echo.
timeout 5
goto end
)
:RunScript
powershell -NoProfile -ExecutionPolicy Bypass -Command "%ChocolateyInstall%\bin\choco-cleaner.ps1"
:end
# choco-cleaner.ps1 by Bill Curran
# LICENSE: GNU GPL v3 - https://www.gnu.org/licenses/gpl.html
# Open a GitHub issue if you have a suggestion/request.
$CCver = "v0.0.3.1 (06/06/2018)"
Write-Host "choco-cleaner.ps1 $CCver - deletes unnecessary residual Chocolatey files to free up disk space" -foreground white
Write-Host "Copyleft 2017-2018 Bill Curran ([email protected]) - free for personal and commercial use" -foreground white
# Import preferences - see choco-cleaner.xml
[xml]$ConfigFile = Get-Content "$env:ChocolateyInstall\bin\choco-cleaner.xml"
$DeleteLogs = $ConfigFile.Settings.Preferences.DeleteLogs
$DeleteArchives = $ConfigFile.Settings.Preferences.DeleteArchives
$DeleteFileLogs = $ConfigFile.Settings.Preferences.DeleteFileLogs
$DeleteMSInstallers = $ConfigFile.Settings.Preferences.DeleteMSInstallers
$DeleteIgnoreFiles = $ConfigFile.Settings.Preferences.DeleteIgnoreFiles
$DeleteReadmes = $ConfigFile.Settings.Preferences.DeleteReadmes
$DeleteOldChoco = $ConfigFile.Settings.Preferences.DeleteOldChoco
$DeleteConfigBackupFile = $ConfigFile.Settings.Preferences.DeleteConfigBackupFile
$DeleteLibBad = $ConfigFile.Settings.Preferences.DeleteLibBad
$DeleteLibBkp = $ConfigFile.Settings.Preferences.DeleteLibBkp
$Optimizenupkg = $ConfigFile.Settings.Preferences.Optimizenupkg
$DeleteCache = $ConfigFile.Settings.Preferences.DeleteCache
$DeleteLicenseFiles = $ConfigFile.Settings.Preferences.DeleteLicenseFiles
# Import chocolatey.config
[xml]$ChocoConfigFile = Get-Content "$env:ChocolateyInstall\config\chocolatey.config"
#parse <add key="cacheLocation" value="" description="Cache location if not TEMP folder. Replaces `$env:TEMP` value." />
#$cacheLocation = $ConfigFile.config.cacheLocation.value
if ($env:ChocolateyInstall -match $env:SystemDrive -and $env:SystemDrive -eq "C:")
{
$FreeBefore = Get-WmiObject Win32_LogicalDisk -Filter "DeviceID='C:'" | Foreach-Object {$_.FreeSpace}
}
Write-Host "choco-cleaner Summary:" -foreground magenta
Write-Host " * Deleting unnecessary _processed.txt (WTF?) file..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\bin\_processed.txt -ErrorAction SilentlyContinue
if ($DeleteLogs)
{
Write-Host " * Deleting unnecessary log files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\logs\* -recurse -exclude chocolatey.log,choco.summary.log -ErrorAction SilentlyContinue
}
if ($DeleteArchives)
{
Write-Host " * Deleting unnecessary archive files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include *.zip,*.rar,*.7z,*.gz,*.tar,*.sfx,*.iso -ErrorAction SilentlyContinue
}
if ($DeleteFileLogs)
{
Write-Host " * Deleting unnecessary extracted file logs..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include *.zip.txt,*.exe.txt,*.rar.txt,*.7z.txt,*.gz.txt,*.tar.txt,*.sfx.txt,*.iso.txt -ErrorAction SilentlyContinue
}
if ($DeleteMSInstallers)
{
Write-Host " * Deleting unnecessary Microsoft installers..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include *.msi,*.msu,*.msp -ErrorAction SilentlyContinue
}
if ($DeleteIgnoreFiles)
{
Write-Host " * Deleting unnecessary .ignore files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include *.ignore -ErrorAction SilentlyContinue
}
if ($DeleteReadmes)
{
Write-Host " * Deleting unnecessary various read me files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include credits.txt,readme.txt,*.md -ErrorAction SilentlyContinue
}
if ($DeleteOldChoco)
{
Write-Host " * Deleting unnecessary old Chocolatey files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include *.old -ErrorAction SilentlyContinue
}
if ($DeleteConfigBackupFile)
{
Write-Host " * Deleting unnecessary config backup files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\config\chocolatey.config.backup -ErrorAction SilentlyContinue
}
if ($DeleteLibBad)
{
Write-Host " * Deleting unnecessary lib-bad files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\lib-bad -recurse -ErrorAction SilentlyContinue
}
if ($DeleteLibBkp)
{
Write-Host " * Deleting unnecessary lib-bkp files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\lib-bkp -recurse -ErrorAction SilentlyContinue
}
if ($DeleteLicenseFiles)
{
Write-Host " * Deleting unnecessary license files..." -foreground magenta
Remove-Item -path $env:chocolateyinstall\* -recurse -include license.txt,*.license.txt,verification.txt -exclude shimgen.license.txt -ErrorAction SilentlyContinue
}
if ($Optimizenupkg)
{
Write-Host " * Deleting unnecessary archives and executables in .nupkg files..." -foreground magenta
dir $env:chocolateyinstall\lib -recurse -include *.nupkg | %{7z d -r -tZIP $_.FullName *.exe *.zip *.rar *.7z *.gz *.tar *.sfx *.iso *.msi *.msu *.msp} | Out-Null
}
# If cacheLocation in chocolatey.config has NOT been changed (most people)...
# I'm going to change this to read in the location from chocolatey.config in the future
if ($DeleteCache)
{
Write-Host " * Deleting unnecessary cache files..." -foreground magenta
Remove-Item -path $env:tmp\chocolatey -recurse -ErrorAction SilentlyContinue
Remove-Item -path $env:SystemRoot\temp\chocolatey -recurse -ErrorAction SilentlyContinue
}
if ($env:ChocolateyInstall -match $env:SystemDrive -and $env:SystemDrive -eq "C:")
{
$FreeAfter = Get-WmiObject Win32_LogicalDisk -Filter "DeviceID='C:'" | Foreach-Object {$_.FreeSpace}
$FreedSpace = $FreeAfter - $FreeBefore
$FreedSpace = $FreedSpace / 1024
Write-Host choco-cleaner finished deleting unnecessary Chocolatey files and saved you $freedspace.ToString('N0') KB! -foreground green
} else {
Write-Host choco-cleaner finished deleting unnecessary Chocolatey files! -foreground green
}
Write-Host "Found choco-cleaner.ps1 useful? Consider buying me a beer via PayPal at https://www.paypal.me/bcurran3donations" -ForegroundColor white
Start-Sleep -s 10
<?xml version="1.0"?>
<Settings>
<Preferences>
<DeleteLicenseFiles>false</DeleteLicenseFiles>
<DeleteLogs>false</DeleteLogs>
<DeleteFileLogs>false</DeleteFileLogs>
<DeleteArchives>true</DeleteArchives>
<DeleteMSInstallers>true</DeleteMSInstallers>
<DeleteIgnoreFiles>true</DeleteIgnoreFiles>
<DeleteReadmes>true</DeleteReadmes>
<DeleteOldChoco>true</DeleteOldChoco>
<DeleteConfigBackupFile>true</DeleteConfigBackupFile>
<DeleteLibBad>true</DeleteLibBad>
<DeleteLibBkp>true</DeleteLibBkp>
<Optimizenupkg>true</Optimizenupkg>
<DeleteCache>true</DeleteCache>
</Preferences>
</Settings>
<!--
#######################################################################################################################
# You can comment out anything above that you do not want to delete such as log or license files with a # at the front of the line.
# File deletion statements (Remove-Item) are purposely grouped for easy disabling based on types of files.
#
# LEGEND:
# * .log files that are not the most current one
# * .zip, .rar, .iso, and various archive files left over from packages that forgot to delete them post install
# * .zip.txt and other archive-extensions.txt are lists of files that were extracted from an archive file for installation
# * .msi, .msu, and .msp are Microsoft intall packages left over from packages that forgot to delete them post install
# * .ignore files are created to not shim executables during package install but not needed after shim operations are finished (This may change in a # future version of Chocolatey.)
# * credits.txt are program credits (of contributors) files you can read on the web
# * readme.txt files you can read on the web
# * .md files are usually markdown readme files that you can read on the web
# * .old files are Chocolatey files that have been replaced by newer versions (exe's and dll's mostly)
# * chocolatey.config.backup is a backup of your chocolatey.config file
# * _processed.txt - I have no idea what made this file
# * lib-bad holds packages that failed to install and lib-bkp contains aborted packages (during updates?)
# * archives and executables out of .nuspkg files which are ZIP archives with NuGet package information - this is similar to what [Package Reducer](https://chocolatey.org/docs/features-package-reducer) does
# * \Users\username\AppData\Local\Temp\chocolatey is where new package files are downloaded to during pre-installation (if you haven't changed your cacheLocation in chocolatey.config)
# * license.txt and verification.txt files are included when packages include binaries, you can read them on the package web page, programname.license.txt files are license files for Chocolatey default tools
#######################################################################################################################
-->
$packageName = 'choco-cleaner'
$script = 'choco-cleaner.ps1'
$xml = 'choco-cleaner.xml'
$shortcutName = 'Choco Cleaner.lnk'
$altshortcutName = 'Chocolatey Cleaner.lnk'
SchTasks /Delete /TN “choco-cleaner” /F
Remove-Item "$env:ChocolateyInstall\bin\$script" -Force -ErrorAction SilentlyContinue
Remove-Item "$env:ChocolateyInstall\bin\$xml" -Force -ErrorAction SilentlyContinue
Remove-Item "$env:ProgramData\Microsoft\Windows\Start Menu\Programs\$altshortcutName" -Force -ErrorAction SilentlyContinue
Remove-Item "$env:ProgramData\Microsoft\Windows\Start Menu\Programs\Chocolatey\$shortcutName" -Force -ErrorAction SilentlyContinue
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.
Copyleft Bill Curran
If you have a previous release of choco-cleaner installed, upgrading to a new version will NOT modify your current scheduled task or preferences.
11:00 PM was chosen as not to conflict with default installs of choco-upgrade-all-at, choco-persistent-packages, and choco-optimize-at.
Organizations with software license compliance auditing should probably NOT delete the license and verification files for legal protection. The supplied configuration file defaults to false for these types of files. As ferventcode/Rob has said many times, corporations are not advised to use the community repository and should be using Chocolatey for Business with their own internalized local packages.
CHANGELOG:
- 0.0.3.1 - fixed typo causing nupkg files to NOT be optimized - thanks E.R.!
- 0.0.3 - Rewritten version of 0.0.1 with XML configuration file and ferventcoder/Rob's approved default settings. Minor improvements.
- 0.0.2 - Unreleased version with two scripts with different default settings; "Bill's way" and "Rob's way" and a package parameter to choose which one to use/install. Shelved.
- 0.0.1 - Initial release. Did not pass Chocolatey moderation due to mandated changes of default parameters. Only "secretly" available.
Ground Rules:
- This discussion is only about (unofficial) Choco Cleaner (Script + Task) and the (unofficial) Choco Cleaner (Script + Task) 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 (unofficial) Choco Cleaner (Script + Task), 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.