Install Autocompress

Autocompress is a Bitbucket add-on and as such it needs to be installed on a Bitbucket workspace. To use Autocompress on more than one workspace, you will need to install and subscribe separately with each workspace. (You can use the free version for public repos simply by installing, no need to pay a subscription).

You can install Autocompress in different ways:
- From Autocompress landing page, hitting the “Install on Bitbucket” button.
- From Bitbucket Marketplace listing of Autocompress, by clicking on the “Get it now” button.
- From the Autocompress home screen, using the “Add a new workspace” button at the bottom of the page.

Log in using your Bitbucket account

To improve security and ease of use, Autocompress does not store credentials of any kind (email, password, etc.). Instead it relies on your Bitbucket account for authentication. All you have to do to sign in is open Autocompress from the “Open” button on the top bar and grant access to your account once you’ve been redirected to Bitbucket. Autocompress will remember your Bitbucket account and log you in immediately next time.

To log out, simply click on your avatar on the top bar and then select “Log out”.

Select a plan

Subscriptions are tied to Bitbucket workspaces. Each workspace requires its own subscription and allows a fixed number of private repositories to be compressed. Public repositories are always free so you don’t need a subscription to use Autocompress on open source projects and other public work.

You can choose a subscription from the Pricing page, which you can find on the top bar. Click on one of the plans to subscribe.

If you haven’t yet installed Autocompress on any workspace, clicking on a plan will trigger the installation flow before you’re redirected to subscribe.

If you installed Autocompress on one workspace, clicking on a plan will upgrade or downgrade the subscription for that plan.

If you have installed more than one workspace, you will be asked which workspace would you like to subscribe for.

Manage your subscriptions

After subscribing with at least one workspace, you can always change your subscriptions by clicking on your avatar on the top bar and then selecting “Manage subscriptions”. On this screen you can Cancel, Update Payment Details and Upgrade your subscription. The “Upgrade” button will also allow you to downgrade the subscription to a lower plan if desired.

Alternatively you can also upgrade or downgrade the subscription for a specific workspace from the home screen.

How the whole compression flow works

Autocompress works like a Git bot, it listens to one of the branches of your repository and detects images (jpg, png, gif, svg, webp) being pushed to that branch.

Whenever an image is added or modified, Autocompress creates a temporary clone of it and attempts to compress it following your compression settings (lossless or lossy). For each image type, it will iterate over several image optimization libraries and algorithms, comparing the results of each one and selecting only the smallest result.

After the image is optimized, Autocompress creates (or reuses) its own branch on your repository, called “autocompress” for simplicity. It pushes the newly compressed image to this branch without deleting any previously compressed images. And lastly it creates a Pull Request with all these compressed images and a stats table for last compression run.

Do not forget to merge the PR if you want to use the optimized images!

Compress a repository for the first time

In order to trigger the compression flow outlined above, you need to activate the desired repository from the Autocompress home screen. To do this, simply click on the toggle button at the right of your repository.

This will trigger a popup explaining that Autocompress will now attempt to optimize ALL the images in the repository, and showing you what setting you have selected (target branch and compression algorithm). Feel free to close the popup and change these settings if needed. If the settings look right to you, go ahead and press “Start compression”.

Have in mind that since this first run compresses all of your images, it might take longer to complete than a normal run. You can repeat this process any time you want to compress the whole repository in one go.

Stop compressing a repository

To stop listening to and compressing a repository, simply click the toggle at the right of an active repository. This will immediately deactivate Autocompress for that repo. Have in mind that the next time you activate the repository, Autocompress will attempt to optimize all of the images in it.

Change the target branch

Autocompress listens by default to your main branch (usually the “master” branch), which means it will only compress images pushed to this branch and will only create PRs for it as well. If you’d like Autocompress to target a different branch in your repo, simply expand the repository settings in the home screen and select the branch you’d like to compress under the “Target branch” menu. The changes are immediate, no need to save them.

Change the compression algorithm

Autocompress uses a lossless compression algorithm by default.

Lossless optimization attempts to compress images in a way that sacrifices no image quality at all. This usually results in bigger image sizes than lossy algorithms would give you, but you don’t lose any detail from the image. Alternatively, a lossy algorithm sacrifices some of this quality in order to obtain much smaller sizes. Autocompress lossy algorithms are all set to lose only up to ~20% image quality, which in most cases would be imperceptible to the naked eye.

You can change this setting at any point by expanding the repository settings in Autocompress home screen and selecting lossy or lossless under the “Compression method” menu. The changes are immediate, no need to save them.
Other apps by us: Pseudoface | AI Filter for Faceless Creators