Skip to content

Support for GitLab, Bitbucket remote templates #3033

Description

@diploidal

Description

As a developer using Vite+ with GitLab, I want vp create to scaffold from templates hosted on GitLab (gitlab.com or self-hosted), so my team can share project templates the same way GitHub users can.

Current behavior (vp v1.1.0)

GitHub works:

$ vp create github:nkzw-tech/fate-template --no-interactive
◇ Scaffolded fate-template
→ Next: cd fate-template && vp run

GitLab, the same public repo in both forms, fails:

$ vp create gitlab:gitlab-org/project-templates/express --no-interactive
◇  Generating project…
■  Template "gitlab:gitlab-org/project-templates/express" not found on npm. Run
   vp create --list to see available templates.

$ vp create https://gitlab.com/gitlab-org/project-templates/express --no-interactive
◇  Generating project…
■  Template "https://gitlab.com/gitlab-org/project-templates/express" not found
   on npm. Run vp create --list to see available templates.

The input isn't recognized as a remote template, so it falls through to the npm package lookup.

Why it matters

  • Many teams, especially companies, host code on GitLab (often self-hosted), not GitHub.
  • Vite+ already supports GitLab on the CI side (setup-vp GitLab template, GitLab CI/CD guide). Scaffolding is the missing piece of that flow.
  • vp create already uses degit for remote templates, and degit already supports these hosts. With degit 3.10.0 directly, both commands above work:
$ pnpm dlx degit@3.10.0 gitlab:gitlab-org/project-templates/express out-nested
> cloned gitlab-org/project-templates/express#HEAD to out-nested

$ pnpm dlx degit@3.10.0 https://gitlab.com/gitlab-org/gitlab-runner-docker-cleanup out-url
> cloned gitlab-org/gitlab-runner-docker-cleanup#HEAD to out-url

So only the template detection in Vite+ is GitHub-only.

Suggested solution

Where the limit is

packages/cli/src/create/discovery.ts (on main):

  • isGitHubUrl() (L12): only matches github:, https://github.com/ and github.com/.
  • parseGitHubUrl() (L21): reduces input to bare user/repo. Fine for GitHub (degit's default host), but it drops the host prefix degit needs for anything else. The URL regex github\.com\/([^/]+\/[^/]+) would also cut GitLab nested groups (group/subgroup/repo).
  • discoverTemplate() (L133): only routes to degit when isGitHubUrl() is true. Everything else falls through to the npm lookup, which gives the "not found on npm" error above.

Related spots:

  • packages/cli/src/create/bin.ts (L597): uses isGitHubUrl / inferGitHubRepoName to infer the target directory.
  • packages/cli/src/create/templates/remote.ts: isGitHubTemplate = command === 'degit' (L26), and the error hint says "Make sure the GitHub repository exists" (L72).
  • expandCreateShorthand() (L234): already skips inputs containing :, so gitlab: and https://gitlab.com/... are safe there. Bare forms like git.sr.ht/user/repo would still need an explicit skip.

What degit already supports (degit 3.10, docs/USAGE.md)

Host Forms
GitLab gitlab:user/repo, https://gitlab.com/user/repo, git@gitlab.com:user/repo
Self-hosted GitLab gitlab://git.example.com/user/repo
Bitbucket bitbucket:user/repo, https://bitbucket.org/user/repo, git@bitbucket.org:user/repo
Sourcehut git.sr.ht/user/repo, https://git.sr.ht/user/repo, git@git.sr.ht:user/repo

It also handles GitLab nested groups, #ref (branch/tag/commit), and private repos over SSH.

Proposed change

  1. Make the GitHub-only helpers generic (e.g. isRemoteGitTemplate, toDegitSource, inferRemoteRepoName), or extend the existing ones.
  2. Detection: also match gitlab:, gitlab://, gitlab.com/, bitbucket:, bitbucket.org/, git.sr.ht/ and git@<host>: forms.
  3. Source passed to degit:
    • GitHub: keep the current behavior (bare user/repo), so nothing changes for existing users.
    • Other hosts: pass the input through as-is, keeping the host. degit already parses these forms, so Vite+ doesn't need its own parser, and nested groups and #ref keep working.
  4. Repo name inference (default target dir): last path segment, without .git or #ref.
  5. expandCreateShorthand(): explicitly skip bare host forms like git.sr.ht/user/repo.
  6. remote.ts error hint: "repository" instead of "GitHub repository", and mention SSH access for private / self-hosted repos.

Tests

packages/cli/src/create/__tests__/discovery.spec.ts:

  • GitHub template helpers (L275): add detection, degit source and repo-name cases for GitLab (shorthand, URL, .git), self-hosted GitLab, a nested group and Bitbucket.
  • should not expand GitHub URLs (L248): add the new forms.
  • discoverTemplate (degit test near L290): add a GitLab case checking command === 'degit' and that the host is kept in args[0].
  • Keep the existing GitHub cases unchanged as a regression guard.

Docs

docs/guide/create.md: update "Template Sources" and the "Use remote templates" examples:

vp create gitlab:user/repo
vp create https://gitlab.com/group/subgroup/repo
vp create gitlab://git.example.com/user/repo
vp create bitbucket:user/repo

Alternative

Workarounds today. Both skip what vp create adds on top (agent files, editor config, hooks, package manager setup):

pnpm dlx degit gitlab:user/repo my-app
cd my-app && vp install

or

git clone --depth 1 https://gitlab.com/user/repo.git my-app

then remove my-app/.git and run vp install.

A smaller first step could be GitLab only (gitlab:, gitlab.com/ and gitlab://), since that's likely where most non-GitHub demand is.

Additional context

Validations

  • Read the Contributing Guidelines.
  • Confirm this request is for Vite+ itself and not for Vite, Vitest, tsdown, Rolldown, or Oxc.
  • Check that there isn't already an issue requesting the same feature.

Activity

  1. changed the title [-]Support for GitLab, Bitbucket and Sourcehut remote templates[/-] [+]Support for GitLab, Bitbucket remote templates[/+] on Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Fields

    Priority

    None yet

    Start date

    None yet

    Target date

    None yet

    Effort

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions