[CLI-109] Add 'ccloud ps1' helper for configuring PS1 prompt by codyaray · Pull Request #197 · confluentinc/cli

Cody A. Ray (codyaray) · 2019-06-05T18:37:21Z

Inspired by https://github.com/djl/vcprompt that a customer mentioned in their zendesk ticket.

https://confluentinc.atlassian.net/browse/CLI-109

Default usage:

$ ./dist/ccloud/darwin_amd64/ccloud help prompt 2>&1 | grep PS1=
  $ export PS1='\u@\h:\W $(ccloud prompt)\n\$ '
  $ export PS1='%n@%m:%~ $(ccloud prompt)$ '

Cody-Rays-MBP15:cli cody$ export PS1='\u@\h:\W $(./dist/ccloud/darwin_amd64/ccloud prompt)\n\$ '
cody@Cody-Rays-MBP15:cli (☪ |Staging:superfaster)
$

Bash prompt:

Zsh prompt:

Subawesome bash prompt (Goland terminal):

We can change our environment and see Confluent change to Staging in the prompt:

cody@Cody-Rays-MBP15:cli (Confluent superfaster)
$ ./dist/ccloud/darwin_amd64/ccloud environment list
     Id    |   Name
+----------+-----------+
    t710   | Confluent
    a-5284 | second
  * a-6249 | Staging
cody@Cody-Rays-MBP15:cli (☪ |Staging:superfaster)
$ ./dist/ccloud/darwin_amd64/ccloud environment use t710
Now using t710 as the default (active) environment.
cody@Cody-Rays-MBP15:cli (☪ |Confluent:superfaster)
$

(Note: this reveals a potential bug- the kafka cluster isn't updated when we switch envs)

We can change our kafka cluster and superfaster changes to prestag in the prompt:

cody@Cody-Rays-MBP15:cli (☪ |Confluent:superfaster)
$ ./dist/ccloud/darwin_amd64/ccloud kafka cluster list
      Id      |      Name       | Provider |  Region   | Durability | Status
+-------------+-----------------+----------+-----------+------------+--------+
    lkc-o39vj | prestag         | aws      | us-west-2 | LOW        | UP
    lkc-5wzm2 | cc-cluster-spec | aws      | us-west-2 | LOW        | UP
    lkc-1jjm3 | superfaster     | aws      | us-west-2 | LOW        | UP
cody@Cody-Rays-MBP15:cli (☪ |Confluent:superfaster)
$ ./dist/ccloud/darwin_amd64/ccloud kafka cluster use lkc-o39vj
cody@Cody-Rays-MBP15:cli (☪ |Confluent:prestag)
$

You can also customize the prompt with format args:

$ export PS1='\u@\h:\W $(dist/ccloud/darwin_amd64/ccloud prompt -f "ccloud env=%E (%e) cluster=%K (%k) user=%u apikey=%a")\n\$ '
cody@Cody-Rays-MBP15:cli ccloud env=Confluent (t710) cluster=prestag (lkc-o39vj) user=cody@confluent.io apikey=(none)
$

Or use an env var for more sophisticated prompts with colors -- env var avoids quote/escape hell

$ CCLOUD_PROMPT_FMT='{{color "blue" "ccloud"}} env={{color "green" "%E (%e)" | colorattr "bold" }} cluster={{color "red" "%K (%k)"}} user=%u apikey=%a'
$ export PS1='\u@\h:\W $(./dist/ccloud/darwin_amd64/ccloud prompt -f "$CCLOUD_PROMPT_FMT")\n\$ '
cody@Cody-Rays-MBP15:cli ccloud env=Confluent (t710) cluster=prestag (lkc-o39vj) user=cody@confluent.io apikey=(none)
$

Open Questions

~~should we call this command ccloud ps1 or ccloud prompt-string or something else?~~ renamed to ccloud prompt
~~do we like having colors like this? (red=prod, yellow=stag, green=dev)~~
~~are we comfortable with "inferring" the environment like this?~~
~~is this order of "inferring" the environment from context, then environment, then kafka cluster name, correct?~~

PR has been updated to only have static user-defined colors for now

Long Help

$ ./dist/ccloud/darwin_amd64/ccloud help prompt
Use this command to add ccloud information in your terminal prompt.

For Bash, you'll want to do something like this:

::

  $ export PS1='\u@\h:\W $(ccloud prompt)\n\$ '

ZSH users should be aware that they will have to set the 'PROMPT_SUBST' option first:

::

  $ setopt prompt_subst
  $ export PS1='%n@%m:%~ $(ccloud prompt)$ '

You can customize the prompt by calling passing a '--format' flag, such as '-f "%X|%E:%K"'.
If you want to create a more sophisticated prompt (such as using the built-in color functions),
it'll be easiest for you if you use an environment variable rather than try to escape the quotes.

::

  $ export CCLOUD_PROMPT_FMT='({{color "blue" "%X"}}|{{color "red" "%E"}}:{{color "cyan" "%K"}})'
  $ export PS1='\u@\h:\W $(ccloud prompt -f "$CCLOUD_PROMPT_FMT")\n\$ '

To make this permanent, you must add it to your bash or zsh profile.

Formats
~~~~~~~

'ccloud prompt' comes with a number of formatting tokens. What follows is a list of all tokens:

* '%C'

  The name of the current context in use. E.g., "dev-app1", "stag-dc1", "prod"

* '%e'

  The ID of the current environment in use. E.g., "a-4567"

* '%E'

  The name of the current environment in use. E.g., "default", "prod-team1"

* '%k'

  The ID of the current Kafka cluster in use. E.g., "lkc-abc123"

* '%K'

  The name of the current Kafka cluster in use. E.g., "prod-us-west-2-iot"

* '%a'

  The current Kafka API key in use. E.g., "ABCDEF1234567890"

* '%u'

  The current user or credentials in use. E.g., "joe@montana.com"

Colors
~~~~~~

There are special functions used for controlling colors.

* {{color "<color>" "some text"}}
* {{fgcolor "<color>" "some text"}}
* {{bgcolor "color>" "some text"}}
* {{colorattr "<attr>" "some text"}}

Available colors: black, red, green, yellow, blue, magenta, cyan, white
Available attributes: bold, underline, invert (swaps the fg/bg colors)

Examples:

* {{color "red" "some text" | colorattr "bold" | bgcolor "blue"}}
* {{color "red"}} some text here {{resetcolor}}

Notes:

* 'color' is just an alias of 'fgcolor'
* calling 'resetcolor' will reset all color attributes, not just the most recently set

You can disable color output by passing the flag '--no-color'.

Usage:
  ccloud prompt [flags]

Flags:
  -f, --format string    The format string to use. See the help for details. (default "({{color \"blue\" \"%X\"}}|{{color \"red\" \"%E\"}}:{{color \"cyan\" \"%K\"}})")
  -g, --no-color         Do not include ANSI color codes in the output.
  -t, --timeout string   The maximum execution time in milliseconds. (default "200ms")
  -h, --help             help for prompt

Global Flags:
  -v, --verbose count   Increase verbosity (-v for warn, -vv for info, -vvv for debug, -vvvv for trace).

codecov · 2019-06-05T20:33:46Z

Codecov Report

❗ No coverage uploaded for pull request base (master@4dbda09). Click here to learn what that means.
The diff coverage is 0%.

@@            Coverage Diff            @@
##             master     #197   +/-   ##
=========================================
  Coverage          ?   41.72%           
=========================================
  Files             ?       44           
  Lines             ?     3319           
  Branches          ?        0           
=========================================
  Hits              ?     1385           
  Misses            ?     1757           
  Partials          ?      177

Impacted Files	Coverage Δ
internal/cmd/command.go	`0% <0%> (ø)`
internal/pkg/config/config.go	`32.94% <0%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4dbda09...98c1f1b. Read the comment docs.

…ause relative directories don't work in PS1 when you cd around

David Hyde (DABH) · 2019-06-08T06:12:07Z

dev/stag/prod are meaningful to us but what about customers? customers might not have their clusters labeled in such a fashion. I see that we are guessing based on this heuristic; would it be better to allow customers to set different colors themselves for different envs? I really am not familiar enough to judge if that's possible, but I'd imagine it's probably tricky to allow that, so maybe there's nothing better we can do for now.
the other thing I'm thinking about is the changes we're proposing right now regarding contexts and authentication etc. If we switch to "proper" context management how would that impact this code? maybe the answer is not much / at all. I do see we have a context formatter already (cool). Will that work right now?
2b. what about on-prem where contexts do not exist / don't have same meaning right now (I guess you could do the url of the mds you're logged into?)? is there a useful thing we can do that's cloud+onprem friendly or is this really only going to benefit ccloud for now?

David Hyde (DABH) · 2019-06-08T06:15:47Z

  kafka           Manage Apache Kafka.
  login           Login to Confluent Cloud.
  logout          Logout of Confluent Cloud.
+  ps1             Print a prompt-string suitable for the PS1 prompt.


If I don't know what a PS1 prompt is by name (but know what it looks like when I use one) it would be helpful if these comments explained a bit more what it is so I know that I'd want to use it.

Suggestions on a suitable short description?

Also, I was actually wondering if ps1 was even a good name for this command. We could just call it prompt... but I wasn't if we'd ever want that for something else (like how you enter mysql shell or ksql or https://github.com/c-bata/kube-prompt... but I guess technically you're now in a shell not a prompt).

Comps:

https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh

https://github.com/jonmosco/kube-ps1/blob/master/kube-ps1.sh#L25

https://github.com/jonmosco/kube-ps1

David Hyde (DABH) · 2019-06-08T06:17:27Z

+func inferColorBasedOnEnvName(name string) func(a ...interface{}) string {
+	name = strings.ToLower(name)
+	if strings.Contains(name, "prod") || strings.Contains(name, "prd") {
+		return red


do colors have to be specified in code or can they be specified with tokens on the command line / prompt?

maybe a general purpose solution here would be to have a map of names->colors in a (the) config file, though reading a file to display the shell prompt sounds like such an inefficient thing 😅

ha, I definitely wondered about this too. There's just so many ways you might want to customize colors.

Take the premise that you'd have a map of names -> colors. But names of what? e.g., context name, account name, kafka cluster name? (We're currently just searching through all three for a match for the magic common env names of prod/prd, stag/stg, or dev.) So this is like a multidimensional config/would need a more complex ruleset to make it truly declarative.

And a different dimension -- We could read the config from a config file, pass it as an arg, pass it as an ENV VAR, etc

My current thoughts (without diving all the way in here) is that customers could "recolor" this however they want through some clever workarounds. Kind of like how this random repo usage works. For example, to colorize the output based on the context name alone:

[[ "$(confluent ps1 -g -f '%c') =~ "prod" ]] && color=red || color=blue PS1='%{$fg[$color]%}$(confluent ps1 -g)%{$reset_color%}'

(this won't actually work as its a bad mix of zsh and bash-isms but it gets the idea across; you'd just use ansi color codes in bash instead.. Speaking of, i wonder if these color codes introduced in this PR work in zsh)

EDIT: this wouldn't work as-is, you'd have to wrap it in a function to dynamically update the colors as your context changes. Maybe something like

func confluent_ps1() { [[ "$(confluent ps1 -g -f '%c') =~ "prod" ]] && color=red || color=blue return '%{$fg[$color]%}$(confluent ps1 -g)%{$reset_color%}' } PS1='$(confluent_ps1)'

In any case, I think we can definitely do this as a follow-up / when a customer requests it. :)

Ok, fine, I switched from dynamic colors based on env to user-defined colors but they can't be dynamic yet.

Also added a symbol to identify this prompt output as coming from Confluent. We're limited to unicode, so I found the closest one to the Confluent logo (which is ☪️). This was more for fun than anything, no idea if product will approve. :)

Default Output Examples

This is the current default output format in various terminals.

Normal bash terminal:

Normal zsh terminal:

Subawesome bash terminal (inside GoLand):

Configuration

This is the default config string:

({{color "blue" "%X"}}|{{color "red" "%E"}}:{{color "cyan" "%K"}})

Here's the docs for configuring colors:

There are special functions used for controlling colors.

{{color "" "some text"}}

{{fgcolor "" "some text"}}

{{bgcolor "color>" "some text"}}

{{colorattr "" "some text"}}

Available colors: black, red, green, yellow, blue, magenta, cyan, white
Available attributes: bold, underline, invert (swaps the fg/bg colors)

Examples:

{{color "red" "some text" | colorattr "bold" | bgcolor "blue"}}

{{color "red"}} some text here {{resetcolor}}

Notes:

'color' is just an alias of 'fgcolor'

calling 'resetcolor' will reset all color attributes, not just the most recently set

You can disable color output by passing the flag '--no-color'.

Ok, I removed the symbol. I'll just use it in my own terminal. :)

Here's the default setup.

For ccloud CLI - (ccloud|{EnvName}:{KafkaClusterName})

For confluent CLI - (confluent|{KafkaClusterName})

As you can see, if there is no Env or Kafka cluster used, then it shows (none)

David Hyde (DABH)

Looks pretty good, left a few comments/questions

…caping curly braces in help message; fix help message to customize fmt env var per CLI name

… set, etc

David Hyde (DABH)

LGTM now, very cool feature!

…or kafka cluster contexts yet

Cody A. Ray (codyaray) · 2019-06-21T17:47:48Z

Changed format in help/usage message. This is what I expect most people will copy/paste.

Both bash and zsh should prepend CLI prompt to existing PS1 (instead of replacing entirely)
This will make the default copy/paste interoperate with other PS1 additions (like git-prompt) better
Also, don't add a newline at the end/before the actual prompt; the user can do that directly in their PS1 string if they wish to do so.

Bash:

Zsh:

(cherry picked from commit 25136d6ec60736d59f717a41428561f52ffa8c66)

…nterval, add Delay Addresses Channing review #11/#13/#14 on PR #197 (companion generator PR) by tightening the wait API and the Flink statement reference adoption. * pkg/wait: rename Options.Tick / PhaseOptions.Tick to PollInterval to match terraform-provider-confluent's StateChangeConf vocabulary. Add Delay (initial sleep before the first Fetch) mirroring StateChangeConf.Delay — gives the API a moment to materialize the resource after a POST, reducing eventually-consistent 404s on the first poll. New tests TestPoll_DelayPostponesFirstFetch and TestPoll_DelayRespectsCtxCancellation cover the contract. * Flink statement create (cloud + on-prem): drop the clierrors alias on pkg/errors and use direct == compare against wait.ErrFailed / wait.ErrTimeout. The wait sentinels are package-level vars returned directly from Poll (never wrapped), so == is correct and avoids importing stdlib errors alongside the CLI errors package — which matches the rest of the codebase's import convention. * Timeout error now includes the latest observed phase: "wait timed out: statement \"x\" is still in phase \"PENDING\"" rather than the bare "wait timed out". Updated create-wait-timeout.golden accordingly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Cody A. Ray (codyaray) added 3 commits June 5, 2019 13:14

Add 'ccloud ps1' helper for configuring PS1 prompt

b51d557

fix help

06f28ac

fix tests

3937986

Cody A. Ray (codyaray) requested a review from a team as a code owner June 5, 2019 18:37

rm go-misc from go.sum

aef21a7

Cody A. Ray (codyaray) added 4 commits June 5, 2019 16:30

update usage instructions for ps1

f56cdfb

Merge branch 'master' into ps1

8201d2b

fix ps1 help to show just the cli name -- assume its on the path, bec…

191073e

…ause relative directories don't work in PS1 when you cd around

no line break for first help line

f900dd7

David Hyde (DABH) reviewed Jun 8, 2019

View reviewed changes

Comment thread internal/pkg/ps1/ps1.go Outdated

David Hyde (DABH) reviewed Jun 8, 2019

View reviewed changes

Comment thread internal/pkg/cmd/config.go

David Hyde (DABH) reviewed Jun 8, 2019

View reviewed changes

Comment thread internal/cmd/ps1/command.go Outdated

David Hyde (DABH) reviewed Jun 8, 2019

View reviewed changes

Cody A. Ray (codyaray) added 13 commits June 12, 2019 15:33

review feedback

f0460b3

rename ps1 -> prompt and update colors help

5c9e0c3

support color functions

90cdd04

switch to user-defined colors, static--nothing dynamic based on env

e955228

fix error messaging for bad template

2f581f6

add comment for icon on bash prompt

e3b1eab

improve docs for using complex formats in PS1

de361c4

fix comment formatting

5eea635

fix comment formatting and --no-color description

a39d1df

add support for format data in addition to tokens

f5db86c

Remove symbol (%X star-and-crescent Confluent-logo lookalike); fix es…

7abcd63

…caping curly braces in help message; fix help message to customize fmt env var per CLI name

fix lint and fix bugs so prompt works even if no context set, no auth…

6820a38

… set, etc

fix missing placeholder bracket

c320253

David Hyde (DABH) approved these changes Jun 21, 2019

View reviewed changes

Cody A. Ray (codyaray) added 2 commits June 21, 2019 12:19

don't show prompt for confluent on-prem CLI since we don't have envs …

778e953

…or kafka cluster contexts yet

update PS1 suggested usage to prepend CLI PS1 to existing PS1

98c1f1b

Cody A. Ray (codyaray) merged commit 55d55cc into master Jun 21, 2019

Cody A. Ray (codyaray) deleted the ps1 branch June 21, 2019 17:49

Brian Strauch (brianstrauch) pushed a commit that referenced this pull request May 31, 2023

[hotfix] Do not overwrite runtime mode (#197)

e5fcc31

(cherry picked from commit 25136d6ec60736d59f717a41428561f52ffa8c66)

Daniel Ayaz (danielayaz) mentioned this pull request May 28, 2026

[APIE-1040] Add generic --wait framework; refactor Flink statement create #3361

Open

13 tasks

Conversation

Cody A. Ray (codyaray) commented Jun 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Open Questions

Long Help

Uh oh!

codecov Bot commented Jun 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

David Hyde (DABH) commented Jun 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

David Hyde (DABH) Jun 8, 2019

Choose a reason for hiding this comment

Uh oh!

Cody A. Ray (codyaray) Jun 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

David Hyde (DABH) Jun 8, 2019

Choose a reason for hiding this comment

Uh oh!

Cody A. Ray (codyaray) Jun 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Cody A. Ray (codyaray) Jun 12, 2019

Choose a reason for hiding this comment

Uh oh!

Cody A. Ray (codyaray) Jun 13, 2019

Choose a reason for hiding this comment

Default Output Examples

Configuration

Uh oh!

Cody A. Ray (codyaray) Jun 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

David Hyde (DABH) left a comment

Choose a reason for hiding this comment

Uh oh!

David Hyde (DABH) left a comment

Choose a reason for hiding this comment

Uh oh!

Cody A. Ray (codyaray) commented Jun 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Cody A. Ray (codyaray) commented Jun 5, 2019 •

edited

Loading

codecov Bot commented Jun 5, 2019 •

edited

Loading

David Hyde (DABH) commented Jun 8, 2019 •

edited

Loading

Cody A. Ray (codyaray) Jun 12, 2019 •

edited

Loading

Cody A. Ray (codyaray) Jun 12, 2019 •

edited

Loading

Cody A. Ray (codyaray) Jun 21, 2019 •

edited

Loading