CX DESIGNSCX-SHIPD DOCS Download cx-shipd
CX-SHIPD DOCUMENTATION

Everything you need
to get started.

Install cx-shipd, understand project updates, configure backend connections, and troubleshoot common setup problems.

Checking the latest stable release…

The download button activates when a valid stable release is published.

Install cx-shipd

Download the latest Windows first-install ZIP from the button above. For Windows app releases, the ZIP contains the versioned application executable, stable launcher, project updater, and update configuration.

  1. 1
    Download the package

    Use the download button on this page or the Latest release card on the home page. If the button is disabled, the maintainer has not published a valid stable manifest yet.

  2. 2
    Extract the ZIP

    Extract it to a folder that your Windows user can write to, such as a folder under your user profile. Don't run the app from inside the ZIP preview.

  3. 3
    Run the stable launcher

    Open cx-shipd-Launcher.exe (or the exact launcher filename provided in the package). Use the launcher instead of opening a versioned EXE directly so the update workflow can find the active release.

  4. 4
    Review Windows prompts

    Windows may show a reputation or publisher warning for an unsigned or newly published app. Only continue if you trust the publisher and obtained the file from the official CX Designs site.

Portable package, not an installer wizard

The current download is a ZIP you extract manually. Downloading a file from the website does not automatically install or run it.

First launch checklist

  • Extract the package into a writable folder.
  • Keep the launcher, updater, versioned executable, and project_update.json together unless the release notes say otherwise.
  • Launch through the stable launcher each time.
  • If cx-shipd asks for backend configuration, enter only the URL and client-side key your project is designed to use.
  • Test the app's main feature before relying on it for important work.

How updates work

The website serves release information and a stable JSON manifest. The local launcher/updater checks that manifest when the application starts, compares versions, and can offer to download a newer release.

01Maintainer publishes

A new version and manifest are deployed to the official release site.

02Launcher checks

The installed app requests the same stable manifest URL.

03User approves

The updater downloads and verifies the file, then switches versions if validation succeeds.

A download is not an automatic update

The website cannot change files on your computer by itself. Updates require the installed app's updater, a trusted HTTPS manifest, and user approval when prompted.

If no update appears, launch through the stable launcher, check that you have an internet connection, and revisit the official site to confirm the latest version and release date.

Backends & integrations

Developers can connect compatible projects to services such as Supabase or other APIs. The correct SDK needs to be part of the project environment and included when the Windows app is built.

  • Supabase: use the project's URL and a publishable/anon key with appropriate authorization policies.
  • Other SDKs: install the required package in the project's Python environment and configure the release builder's backend preset if available.
  • Dynamic imports: add a PyInstaller hidden import only when a required module isn't detected during the build.
  • Test the packaged EXE: an app working in VS Code doesn't guarantee that every dependency or data file is included in the release.

Backend setup depends on the application. cx-shipd's website doesn't create backend accounts or supply private credentials for your project.

Security checklist

  • Never package .env secrets, database administrator passwords, signing keys, or privileged service-account credentials.
  • Never embed Supabase service_role or sb_secret_ keys in a public desktop app.
  • Use HTTPS for the release website, manifests, and binary downloads.
  • Review the release file list before publishing. Excluding common secret filenames is helpful but cannot detect every sensitive value.
  • A SHA-256 hash detects mismatch or corruption; it does not protect against a compromised release host or manifest.
  • Only install packages downloaded from a release site you trust.

Common problems

The Download button is disabled

The site has not loaded a valid stable manifest. In the website folder, run python publish_release.py and select the generated netlify_site folder from the cx-shipd release. The helper imports the manifest and package files and creates the canonical cx-shipd-stable.json filename. Then deploy the merged public folder to Netlify. Open the manifest URL directly; it should return JSON rather than a 404 page.

The download link returns 404

Check that the manifest's download_url and install_url match the actual deployed paths. If you use an external file host, verify the URL in a private browser window and make sure it is a direct HTTPS file URL.

The app opens in VS Code but not as an EXE

Check the build logs for missing modules, data files, or native libraries. Add a hidden import only for a specific missing module, rebuild in the project's environment, then test the new EXE before publishing.

The app doesn't find an update

Check that the installed configuration and website point to the same stable manifest URL, the published version is higher than the installed version, and the new manifest was deployed after the release files.

The manifest says the release is invalid

Check the JSON syntax, semantic version format, expected channel, HTTPS URL, positive size_bytes, and 64-character hexadecimal SHA-256 digest.

For developers

Code normally in VS Code. Use Designer Dashboard Studio to link only the project folder you intend to release, select the correct Python entry point, choose required backend integrations, and build a versioned release.

  1. Test the project in its own virtual environment.
  2. Review included files and exclude credentials and unrelated projects.
  3. Build and test the release locally.
  4. Import the generated netlify_site folder with publish_release.py.
  5. Deploy the updated website's public folder to Netlify.
  6. Test a real update from an older version before announcing the new release.
View latest cx-shipd release
READY TO GET STARTED?

Download the latest cx-shipd release.

The current release link loads from the official stable manifest.

Download cx-shipd