{"id":49232641,"url":"https://github.com/flathub-infra/ide-flatpak-wrapper","last_synced_at":"2026-04-24T12:35:13.156Z","repository":{"id":41814807,"uuid":"278710288","full_name":"flathub-infra/ide-flatpak-wrapper","owner":"flathub-infra","description":"Wrapper for setting up development environment in flatpak sandbox","archived":false,"fork":false,"pushed_at":"2026-04-21T11:45:27.000Z","size":39,"stargazers_count":22,"open_issues_count":10,"forks_count":16,"subscribers_count":6,"default_branch":"master","last_synced_at":"2026-04-21T13:34:19.663Z","etag":null,"topics":["bash","flatpak","vscode","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flathub-infra.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-07-10T18:51:29.000Z","updated_at":"2026-04-21T11:45:20.000Z","dependencies_parsed_at":"2022-07-16T02:18:12.269Z","dependency_job_id":"531cb328-81f8-44e1-b274-755968f841bc","html_url":"https://github.com/flathub-infra/ide-flatpak-wrapper","commit_stats":null,"previous_names":["flathub-infra/ide-flatpak-wrapper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/flathub-infra/ide-flatpak-wrapper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathub-infra%2Fide-flatpak-wrapper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathub-infra%2Fide-flatpak-wrapper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathub-infra%2Fide-flatpak-wrapper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathub-infra%2Fide-flatpak-wrapper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flathub-infra","download_url":"https://codeload.github.com/flathub-infra/ide-flatpak-wrapper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flathub-infra%2Fide-flatpak-wrapper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32224396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T10:26:35.452Z","status":"ssl_error","status_checked_at":"2026-04-24T10:25:27.643Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","flatpak","vscode","wrapper"],"created_at":"2026-04-24T12:35:12.452Z","updated_at":"2026-04-24T12:35:13.144Z","avatar_url":"https://github.com/flathub-infra.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flatpak editor wrapper\n\nThis wrapper sets up development environment before launching the editor inside flatpak sandbox.\n\nCurrent functions:\n\n* Show up a readme on first launch\n* Show up a notice after SDK update\n* Enable installed SDK extensions (from `/usr/lib/sdk`)\n  * `FLATPAK_ENABLE_SDK_EXT` must be set to a comma-separated list or `*`\n* Enable installed development tools (from `/app/tools`)\n* Isolate npm/pip/cargo/etc packages from host environment\n\n## Usage\n\nUsage of this module consists of:\n\n  1. Sourcing this repository as a git source.\n  1. Creating a module in your flatpak's build file that specifies the options you want to use.\n  1. Overwriting your flatpak's entry points to run the wrapper instead of the actual program's\n  executable. This must be done on the \"command\" key of your build file as well as on the\n  \".desktop\" file of your upstream.\n\nSome aspects of this module's behaviour may be changed using environment variables, see the full listing in the \"Environment Variables\" section below.\n\n### Sourcing this Repository\n\nTo use this repository use the git source. Example:\n\n```yaml\n  - name: ide-flatpak-wrapper\n    buildsystem: meson\n    config-opts:\n      # your config opts (more on this later)\n    sources:\n      - type: git\n        url: https://github.com/flathub/ide-flatpak-wrapper.git\n        commit: \u003cinsert_the_commit\u003e\n```\n\nMake sure you add the proper commit. Use of `branch` isn't allowed on flathub.\n\n### Specifying Config Options\n\nFor this module to work properly, we must specify a minimum of 2 options - the path to your editor's\nbinary and a name to install the wrapper under:\n\n```yaml\n  - name: ide-flatpak-wrapper\n    buildsystem: meson\n    config-opts:\n      # Path to the editor executable\n      - -Deditor_binary=/app/main/bin/code-oss\n      # Install wrapper under this name (must be different from the above)\n      - -Dprogram_name=code-oss-wrapper\n    sources:\n      # your source choice\n```\n\nAdditionally, you may specify the following options:\n\n* `-Deditor_args` Command line args to append to the editor executable.\n* `-Deditor_title` Human readable title of the editor. This will be interpolated into the \"first run template\"\n      file (more on this file later).\n* `-Dfirst_run_template` Name of the file that will be opened on your editor's first run.\n* `-Dsdk_update_template` Name of the file that will be opened when your flatpak updates its SDK. This can be\n      used to inform the user that the SDK extensions they were using before must be updated as well.\n* `-Dflagfile_prefix` An arbitrary string prepended to `-first-run` and `-sdk-update-` files names that indicate\n      that we already did show the corresponding readme.\n* `-Ddefault_loglevel` The default loglevel. May be overwritten by user with FLATPAK_IDE_LOGLEVEL environment variable.\n\n### Overwriting the Flatpak's Entry Points\n\nNow that you have your wrapper configured, you must ensure **it** is executed instead of your actual editor's\nbinary. Typically your flatpak will have two entry points: the `command` key of your build file which is used\nwhen the flatpak is executed using the `flatpak run` command and the desktop file which is used when the user\nclicks on your editor's icon from their desktop environment. If the desktop file comes from upstream you will\nneed to patch the `Exec` line to call the wrapper.\n\n### First Run and SDK Update Templates\n\nTo inform your user of the particulars of flatpaks, you can include a first run template and an SDK update template\nwhich will be run once after each of those events. You must include those files in the `sources` section of the\nmodule:\n\n```yaml\n  - name: ide-flatpak-wrapper\n    buildsystem: meson\n    config-opts:\n      # your options\n    sources:\n      # your source choice\n      - type: file\n        path: ide-first-run.txt\n      - type: file\n        path: sdk-update.txt\n```\n\nThose template files have string interpolation for the `EDITOR_TITLE` and `FLATPAK_ID` using the `@` symbol.\nFor example, using an editor title of \"VS Code\" and a flatpak ID of \"com.visualstudio.code\" the template file\nwould go from this:\n\n```\n------------------------------------------------------------------------------------\n| Warning: You are running an unofficial Flatpak version of @EDITOR_TITLE@ !!! |\n------------------------------------------------------------------------------------\n\nPlease open issues under: https://github.com/flathub/@FLATPAK_ID@/issues\n```\n\nTo this:\n\n```\n------------------------------------------------------------------------------------\n| Warning: You are running an unofficial Flatpak version of VS Code !!! |\n------------------------------------------------------------------------------------\n\nPlease open issues under: https://github.com/flathub/com.visualstudio.code/issues\n```\n\n## Environment Variables\n\nYou may use the following environment variables to change the behaviour of the ide-flatpak-wrapper:\n\n* `FLATPAK_IDE_LOGLEVEL` (= `1`)\n\n  Controls verbosity of the module, `0` supresses all module-originated outputs to stdout.\n\n  * Type: Number (`0` | `1`)\n\n* `FLATPAK_PREFER_USER_PACKAGES` (= `0`)\n\n* `FLATPAK_ISOLATE_PACKAGES` (= `1`)\n\n* `FLATPAK_ISOLATE_NPM` (= `FLATPAK_ISOLATE_PACKAGES`)\n\n* `FLATPAK_PREFER_USER_NPM` (= `FLATPAK_PREFER_USER_PACKAGES`)\n\n* `FLATPAK_ISOLATE_CARGO` (= `FLATPAK_ISOLATE_PACKAGES`)\n\n* `FLATPAK_PREFER_USER_CARGO` (= `FLATPAK_PREFER_USER_PACKAGES`)\n\n* `FLATPAK_ISOLATE_PIP` (= `FLATPAK_ISOLATE_PACKAGES`)\n\n* `FLATPAK_PREFER_USER_PIP` (= `FLATPAK_PREFER_USER_PACKAGES`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflathub-infra%2Fide-flatpak-wrapper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflathub-infra%2Fide-flatpak-wrapper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflathub-infra%2Fide-flatpak-wrapper/lists"}