Skip to content

fix(enterprise): update external agent instructions in cli #19411

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 2 commits into from
Aug 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions enterprise/cli/externalworkspaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -243,15 +243,14 @@ func fetchExternalAgents(inv *serpent.Invocation, client *codersdk.Client, works
// formatExternalAgent formats the instructions for an external agent.
func formatExternalAgent(workspaceName string, externalAgents []externalAgent) string {
var output strings.Builder
_, _ = output.WriteString(fmt.Sprintf("\nPlease run the following commands to attach external agent to the workspace %s:\n\n", cliui.Keyword(workspaceName)))
_, _ = output.WriteString(fmt.Sprintf("\nPlease run the following command to attach external agent to the workspace %s:\n\n", cliui.Keyword(workspaceName)))

for i, agent := range externalAgents {
if len(externalAgents) > 1 {
_, _ = output.WriteString(fmt.Sprintf("For agent %s:\n", cliui.Keyword(agent.AgentName)))
}

_, _ = output.WriteString(fmt.Sprintf("%s\n", pretty.Sprint(cliui.DefaultStyles.Code, fmt.Sprintf("export CODER_AGENT_TOKEN=%s", agent.AuthToken))))
_, _ = output.WriteString(fmt.Sprintf("%s\n", pretty.Sprint(cliui.DefaultStyles.Code, fmt.Sprintf("curl -fsSL %s | sh", agent.InitScript))))
_, _ = output.WriteString(fmt.Sprintf("%s\n", pretty.Sprint(cliui.DefaultStyles.Code, agent.InitScript)))

if i < len(externalAgents)-1 {
_, _ = output.WriteString("\n")
Expand Down
25 changes: 13 additions & 12 deletions enterprise/cli/externalworkspaces_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,11 @@ func TestExternalWorkspaces(t *testing.T) {
pty.WriteLine("yes")

// Expect the external agent instructions
pty.ExpectMatch("Please run the following commands to attach external agent")
pty.ExpectMatch("export CODER_AGENT_TOKEN=")
pty.ExpectMatch("curl -fsSL")
pty.ExpectMatch("Please run the following command to attach external agent")
pty.ExpectRegexMatch("curl -fsSL .* | CODER_AGENT_TOKEN=.* sh")

<-doneChan
ctx := testutil.Context(t, testutil.WaitLong)
testutil.TryReceive(ctx, t, doneChan)

// Verify the workspace was created
ws, err := member.WorkspaceByOwnerAndName(context.Background(), codersdk.Me, "my-external-workspace", codersdk.WorkspaceOptions{})
Expand Down Expand Up @@ -392,11 +392,12 @@ func TestExternalWorkspaces(t *testing.T) {
assert.NoError(t, errC)
close(done)
}()
pty.ExpectMatch("Please run the following commands to attach external agent to the workspace")
pty.ExpectMatch("export CODER_AGENT_TOKEN=")
pty.ExpectMatch("curl -fsSL")
pty.ExpectMatch("Please run the following command to attach external agent to the workspace")
pty.ExpectRegexMatch("curl -fsSL .* | CODER_AGENT_TOKEN=.* sh")
cancelFunc()
<-done

ctx = testutil.Context(t, testutil.WaitLong)
testutil.TryReceive(ctx, t, done)
})

t.Run("AgentInstructionsJSON", func(t *testing.T) {
Expand Down Expand Up @@ -545,11 +546,11 @@ func TestExternalWorkspaces(t *testing.T) {
pty.ExpectMatch("external-agent (linux, amd64)")

// Expect the external agent instructions
pty.ExpectMatch("Please run the following commands to attach external agent")
pty.ExpectMatch("export CODER_AGENT_TOKEN=")
pty.ExpectMatch("curl -fsSL")
pty.ExpectMatch("Please run the following command to attach external agent")
pty.ExpectRegexMatch("curl -fsSL .* | CODER_AGENT_TOKEN=.* sh")

<-doneChan
ctx := testutil.Context(t, testutil.WaitLong)
testutil.TryReceive(ctx, t, doneChan)

// Verify the workspace was created
ws, err := member.WorkspaceByOwnerAndName(context.Background(), codersdk.Me, "my-external-workspace", codersdk.WorkspaceOptions{})
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy