✨ Show org in prompt (#442)

Author: mcncl

README.md

@@ -57,6 +57,10 @@ Use "bk [command] --help" for more information about a command.
 
 You'll need to run `bk configure` first to set up your organization and API token.
 
+### Shell Prompt Integration
+
+Want to display your current Buildkite organization in your shell prompt? Check out our [Shell Prompt Integration Guide](/docs/shell-prompt-integration.md) for detailed instructions for Zsh, Bash, and Powerlevel10k.
+
 ## 💬 Feedback
 
 We'd love to hear any feedback and questions you might have. Please [file an issue on GitHub](https://github.com/buildkite/cli/issues) and let us know!

docs/images/prompt.png

@@ -0,0 +1,111 @@
+### Shell Prompt Integration
+
+The Buildkite CLI offers a shell prompt integration that displays your current Buildkite organization directly in your prompt.
+
+![bk cli prompt](./images/prompt.png)
+
+#### Zsh (Vanilla)
+
+1. Create a prompt function in `~/.buildkite/zsh_prompt.zsh`:
+
+```zsh
+_buildkite_ps1() {
+    local org=$(bk use 2>&1 | grep "Using configuration for" | sed -E "s/Using configuration for \`(.*)\`/\1/")
+    if [[ -n "$org" ]]; then
+        echo -n " (bk:$org)"
+    fi
+}
+
+# Modify your existing prompt to include the Buildkite organization
+PROMPT='%n@%m %1~$(_buildkite_ps1)%# '
+```
+
+2. Source the script in your `.zshrc`:
+
+```zsh
+source $HOME/.buildkite/zsh_prompt.zsh
+```
+
+#### Zsh (Powerlevel10k)
+
+1. Add the following function to `~/.buildkite/zsh_prompt.zsh`:
+
+```zsh
+_buildkite_ps1() {
+    # Cache the prompt output for 5 seconds to avoid running bk too frequently
+    if [[ -z "$BK_PROMPT_CACHE" ]] || [[ $(($EPOCHSECONDS % 5)) -eq 0 ]]; then
+        local org=$(bk use 2>&1 | grep "Using configuration for" | sed -E "s/Using configuration for \`(.*)\`/\1/")
+        if [[ -n "$org" ]]; then
+            BK_PROMPT_CACHE="%F{magenta}(bk:$org)%f"
+        else
+            BK_PROMPT_CACHE="%F{yellow}(bk:not configured)%f"
+        fi
+    fi
+    echo -n "$BK_PROMPT_CACHE"
+}
+
+# Wrap the bk command to clear prompt cache when switching orgs
+bk() {
+    command bk "$@"
+    if [[ "$1" == "use" ]]; then
+        unset BK_PROMPT_CACHE
+    fi
+}
+```
+
+2. Source this script in your `.zshrc`:
+
+```zsh
+source $HOME/.buildkite/zsh_prompt.zsh
+```
+
+3. Add the Buildkite organization to your prompt elements in `~/.p10k.zsh`:
+
+```zsh
+typeset -g POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(
+  # ... other existing elements
+  buildkite_org
+)
+```
+
+#### Bash
+
+1. Create a prompt function in `~/.buildkite/bash_prompt.sh`:
+
+```bash
+_buildkite_ps1() {
+    local org=$(bk use 2>&1 | grep "Using configuration for" | sed -E "s/Using configuration for \`(.*)\`/\1/")
+    if [[ -n "$org" ]]; then
+        echo -n " (bk:$org)"
+    fi
+}
+
+# Modify your PS1 to include the Buildkite organization
+export PS1='\u@\h \w$(_buildkite_ps1)\$ '
+```
+
+2. Source the script in your `.bashrc`:
+
+```bash
+source $HOME/.buildkite/bash_prompt.sh
+```
+
+#### Features
+
+- Displays current Buildkite organization in your shell prompt
+- Caches organization info to minimize performance impact
+- Works across different projects and directories
+- Supports quick organization switching with `bk use`
+
+#### Troubleshooting
+
+- Ensure you've run `bk configure` to set up your organization
+- Verify the `.bk.yaml` in your project's root directory
+- Check that you're using a locally built `bk` binary in development projects
+
+#### Performance Considerations
+
+The prompt integration uses a lightweight method to retrieve the current organization. However, to minimize any potential performance impact:
+- The script caches the organization name
+- The command is only run periodically or when switching organizations
+- You can customize the caching mechanism if needed

docs/shell-prompt-integration.md

@@ -0,0 +1,70 @@
+package prompt
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/buildkite/cli/v3/pkg/cmd/factory"
+	"github.com/spf13/cobra"
+)
+
+func NewCmdPrompt(f *factory.Factory) *cobra.Command {
+	var format string
+	var shellType string
+
+	cmd := &cobra.Command{
+		Use:    "prompt",
+		Hidden: true, // Hide from general help as it's meant for shell integration
+		Short:  "Print shell prompt integration",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			org := f.Config.OrganizationSlug()
+			if org == "" {
+				return nil // No org configured, return empty
+			}
+
+			// Get token scopes to potentially show warnings
+			scopes := f.Config.GetTokenScopes()
+			var warnings []string
+			if len(scopes) < 3 { // Example threshold
+				warnings = append(warnings, "!")
+			}
+
+			// Format the prompt based on shell type
+			switch shellType {
+			case "bash":
+				if format == "" {
+					format = "\\[\\033[35m\\](bk:%s%s)\\[\\033[0m\\]" // Purple color by default
+				}
+				fmt.Printf(format, org, strings.Join(warnings, ""))
+			case "zsh":
+				if format == "" {
+					format = "%%F{magenta}(bk:%s%s)%%f"
+				}
+				fmt.Printf(format, org, strings.Join(warnings, ""))
+			case "fish":
+				if format == "" {
+					format = "set_color magenta;echo -n '(bk:%s%s)';set_color normal"
+				}
+				fmt.Printf(format, org, strings.Join(warnings, ""))
+			}
+
+			return nil
+		},
+	}
+
+	cmd.Flags().StringVar(&format, "format", "", "Custom format string for the prompt")
+	cmd.Flags().StringVar(&shellType, "shell", detectShell(), "Shell type (bash, zsh, or fish)")
+
+	return cmd
+}
+
+func detectShell() string {
+	shell := os.Getenv("SHELL")
+	if strings.Contains(shell, "zsh") {
+		return "zsh"
+	} else if strings.Contains(shell, "fish") {
+		return "fish"
+	}
+	return "bash"
+}

pkg/cmd/prompt/prompt.go

@@ -15,6 +15,7 @@ import (
 	jobCmd "github.com/buildkite/cli/v3/pkg/cmd/job"
 	pipelineCmd "github.com/buildkite/cli/v3/pkg/cmd/pipeline"
 	packageCmd "github.com/buildkite/cli/v3/pkg/cmd/pkg"
+	promptCmd "github.com/buildkite/cli/v3/pkg/cmd/prompt"
 	useCmd "github.com/buildkite/cli/v3/pkg/cmd/use"
 	"github.com/buildkite/cli/v3/pkg/cmd/user"
 	versionCmd "github.com/buildkite/cli/v3/pkg/cmd/version"
@@ -52,8 +53,9 @@ func NewCmdRoot(f *factory.Factory) (*cobra.Command, error) {
 	cmd.AddCommand(configureCmd.NewCmdConfigure(f))
 	cmd.AddCommand(initCmd.NewCmdInit(f))
 	cmd.AddCommand(jobCmd.NewCmdJob(f))
-	cmd.AddCommand(pipelineCmd.NewCmdPipeline(f))
 	cmd.AddCommand(packageCmd.NewCmdPackage(f))
+	cmd.AddCommand(pipelineCmd.NewCmdPipeline(f))
+	cmd.AddCommand(promptCmd.NewCmdPrompt(f))
 	cmd.AddCommand(useCmd.NewCmdUse(f))
 	cmd.AddCommand(user.CommandUser(f))
 	cmd.AddCommand(versionCmd.NewCmdVersion(f))