Skip to content

feat(cli): Add 'dotfiles' command for managing your dotfiles #20884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

rkarahan80
Copy link

This commit introduces a new dotfiles command to the Gitpod CLI (gp). This command allows you to manage the dotfiles repository linked to your Gitpod account directly from the command line.

The dotfiles command includes the following subcommands:

  • gp dotfiles link <repository-url>: Links a new dotfiles repository to your Gitpod account. Gitpod will clone this repository into workspaces and run any installation scripts.
  • gp dotfiles remove: Removes the currently linked dotfiles repository from your account.
  • gp dotfiles update: Manually triggers an update of the dotfiles in the current workspace or for subsequent workspaces.

Unit tests have been added for the new commands, mocking the server interaction. The pkg/gitpod/server.go file has been updated to define a Server interface and export a GetServer variable to facilitate testing.

Documentation for the new command has been added to the components/gitpod-cli/README.md file.

Description

Related Issue(s)

Fixes #

How to test

Documentation

Preview status

gitpod:summary

Build Options

Build
  • /werft with-werft
    Run the build with werft instead of GHA
  • leeway-no-cache
  • /werft no-test
    Run Leeway with --dont-test
Publish
  • /werft publish-to-npm
  • /werft publish-to-jb-marketplace
Installer
  • analytics=segment
  • with-dedicated-emulation
  • workspace-feature-flags
    Add desired feature flags to the end of the line above, space separated
Preview Environment / Integration Tests
  • /werft with-local-preview
    If enabled this will build install/preview
  • /werft with-preview
  • /werft with-large-vm
  • /werft with-gce-vm
    If enabled this will create the environment on GCE infra
  • /werft preemptible
    Saves cost. Untick this only if you're really sure you need a non-preemtible machine.
  • with-integration-tests=all
    Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh. If enabled, with-preview and with-large-vm will be enabled.
  • with-monitoring

/hold

Sorry, something went wrong.

This commit introduces a new `dotfiles` command to the Gitpod CLI (`gp`).
This command allows you to manage the dotfiles repository linked to your
Gitpod account directly from the command line.

The `dotfiles` command includes the following subcommands:

- `gp dotfiles link <repository-url>`: Links a new dotfiles repository
  to your Gitpod account. Gitpod will clone this repository into
  workspaces and run any installation scripts.
- `gp dotfiles remove`: Removes the currently linked dotfiles repository
  from your account.
- `gp dotfiles update`: Manually triggers an update of the dotfiles
  in the current workspace or for subsequent workspaces.

Unit tests have been added for the new commands, mocking the server
interaction. The `pkg/gitpod/server.go` file has been updated to
define a `Server` interface and export a `GetServer` variable to
facilitate testing.

Documentation for the new command has been added to the
`components/gitpod-cli/README.md` file.
@rkarahan80 rkarahan80 requested review from a team as code owners June 8, 2025 07:48
@rkarahan80 rkarahan80 closed this by deleting the head repository Jun 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants