Skip to content

feat(jetbrains-fleet): add Fleet IDE module for JetBrains integration #176

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

Merged
merged 19 commits into from
Jul 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ae25328
feat(fleet-ide): add Fleet IDE module for JetBrains integration
DevelopmentCats Jun 25, 2025
16fe32b
Merge branch 'main' into cat/fleet-ide
matifali Jul 3, 2025
f80a785
docs: update frontmatter display to Jetbrains Fleet
DevelopmentCats Jul 4, 2025
c77f231
docs: remove unnecessary explanation
DevelopmentCats Jul 4, 2025
6ae2f1a
docs: add coder cli info
DevelopmentCats Jul 4, 2025
a665405
fix: simplify Fleet connection URL by removing unnecessary parameter
DevelopmentCats Jul 4, 2025
02acfd0
docs: move important note about Coder CLI and Desktop requirements fo…
DevelopmentCats Jul 4, 2025
fb48bd5
fix: update Fleet connection URL to include workspace and owner param…
DevelopmentCats Jul 4, 2025
5c11d53
chore: update fleet display name
DevelopmentCats Jul 4, 2025
6b2de7b
fix: update Fleet connection URLs to consistently include workspace a…
DevelopmentCats Jul 5, 2025
4eeea69
Rename fleet-ide to jetbrains-fleet module
matifali Jul 8, 2025
47a830b
Merge branch 'main' into cat/fleet-ide
matifali Jul 8, 2025
3bea223
fix: update fleet URL generation in jetbrains-fleet module
DevelopmentCats Jul 9, 2025
d0b59d6
Merge branch 'main' into cat/fleet-ide
DevelopmentCats Jul 9, 2025
26d652e
feat(jetbrains): Add agent_name variable and update fleet URL generation
DevelopmentCats Jul 9, 2025
90aee2b
fix(jetbrains-fleet): update test suite to reflect module name change…
DevelopmentCats Jul 9, 2025
e463551
Merge branch 'main' into cat/fleet-ide
DevelopmentCats Jul 9, 2025
3dc1a1d
chore: update important tag
DevelopmentCats Jul 9, 2025
082c69b
docs(jetbrains-fleet): update README for module name consistency and …
DevelopmentCats Jul 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .icons/fleet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 81 additions & 0 deletions registry/coder/modules/jetbrains-fleet/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
display_name: JetBrains Fleet
description: Add a one-click button to launch JetBrains Fleet to connect to your workspace.
icon: ../../../../.icons/jetbrains.svg
verified: true
tags: [ide, jetbrains, fleet]
---

# Jetbrains Fleet

This module adds a Jetbrains Fleet button to your Coder workspace that opens the workspace in JetBrains Fleet using SSH remote development.

JetBrains Fleet is a next-generation IDE that supports collaborative development and distributed architectures. It connects to your Coder workspace via SSH, providing a seamless remote development experience.

```tf
module "jetbrains_fleet" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/jetbrains-fleet/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

## Requirements

- JetBrains Fleet must be installed locally on your development machine
- Download Fleet from: https://www.jetbrains.com/fleet/

> [!IMPORTANT]
> Fleet needs you to either have Coder CLI installed with `coder config-ssh` run or [Coder Desktop](https://coder.com/docs/user-guides/desktop).

## Examples

### Basic usage

```tf
module "jetbrains_fleet" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/jetbrains-fleet/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

### Open a specific folder

```tf
module "jetbrains_fleet" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/jetbrains-fleet/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
}
```

### Customize app name and grouping

```tf
module "jetbrains_fleet" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/jetbrains-fleet/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
display_name = "Fleet"
group = "JetBrains IDEs"
order = 1
}
```

### With custom agent name

```tf
module "jetbrains_fleet" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/jetbrains-fleet/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
agent_name = coder_agent.example.name
}
```
100 changes: 100 additions & 0 deletions registry/coder/modules/jetbrains-fleet/main.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import { describe, expect, it } from "bun:test";
import {
runTerraformApply,
runTerraformInit,
testRequiredVariables,
} from "~test";

describe("jetbrains-fleet", async () => {
await runTerraformInit(import.meta.dir);

testRequiredVariables(import.meta.dir, {
agent_id: "foo",
});

it("default output", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/default.coder",
);

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.order).toBeNull();
});

it("adds folder", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
folder: "/foo/bar",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/default.coder?pwd=/foo/bar",
);
});

it("adds agent_name to hostname", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
agent_name: "myagent",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/myagent.default.default.coder",
);
});

it("custom display name and slug", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
display_name: "My Fleet",
slug: "my-fleet",
});
expect(state.outputs.fleet_url.value).toBe(
"fleet://fleet.ssh/default.coder",
);

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances[0].attributes.display_name).toBe("My Fleet");
expect(coder_app?.instances[0].attributes.slug).toBe("my-fleet");
});

it("expect order to be set", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
order: "22",
});

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.order).toBe(22);
});

it("expect group to be set", async () => {
const state = await runTerraformApply(import.meta.dir, {
agent_id: "foo",
group: "JetBrains IDEs",
});

const coder_app = state.resources.find(
(res) => res.type === "coder_app" && res.name === "fleet",
);

expect(coder_app).not.toBeNull();
expect(coder_app?.instances.length).toBe(1);
expect(coder_app?.instances[0].attributes.group).toBe("JetBrains IDEs");
});
});
81 changes: 81 additions & 0 deletions registry/coder/modules/jetbrains-fleet/main.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
terraform {
required_version = ">= 1.0"

required_providers {
coder = {
source = "coder/coder"
version = ">= 2.5"
}
}
}

variable "agent_id" {
type = string
description = "The ID of a Coder agent."
}

variable "agent_name" {
type = string
description = "The name of the agent"
default = ""
}

variable "folder" {
type = string
description = "The folder to open in Fleet IDE."
default = ""
}

variable "order" {
type = number
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
default = null
}

variable "group" {
type = string
description = "The name of a group that this app belongs to."
default = null
}

variable "slug" {
type = string
description = "The slug of the app."
default = "fleet"
}

variable "display_name" {
type = string
description = "The display name of the app."
default = "JetBrains Fleet"
}

data "coder_workspace" "me" {}
data "coder_workspace_owner" "me" {}

locals {
workspace_name = lower(data.coder_workspace.me.name)
owner_name = lower(data.coder_workspace_owner.me.name)
agent_name = lower(var.agent_name)
hostname = var.agent_name != "" ? "${local.agent_name}.${local.workspace_name}.${local.owner_name}.coder" : "${local.workspace_name}.coder"
}

resource "coder_app" "fleet" {
agent_id = var.agent_id
external = true
icon = "/icon/fleet.svg"
slug = var.slug
display_name = var.display_name
order = var.order
group = var.group
url = join("", [
"fleet://fleet.ssh/",
local.hostname,
var.folder != "" ? join("", ["?pwd=", var.folder]) : ""
])
}

output "fleet_url" {
value = coder_app.fleet.url
description = "Fleet IDE connection URL."
}