apache/pulsar

pulsar-shell persistent modes

Open

#21,194 opened on Sep 16, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (13,697 stars) (3,485 forks)batch import
Stalehelp wantedtype/enhancement

Description

Search before asking

  • I searched in the issues and found nothing similar.

Motivation

Using pulsar-shell interactively, it's kind of a pain to prefix everything withadmin. I think it would be nice if the command accepted admin and client on their own as special commands that put the command into that mode with an implicit prefix.

Solution

Allow admin and client, when passed on their own to enter into admin or client mode respectively, with the addition of one more command exitmode to return to the base state. These modes would not persist between sessions.

configname(hostname)> admin
configname(hostname) admin> help
Usage: pulsar-admin [options] [command] [command options]
  Options:
    --admin-url
      Admin Service URL to which to connect.
      Default: https://pulsar.eks.intel.cs.sys:443
<SNIP>
    namespaces      Operations about namespaces
      Usage: namespaces [options]

configname(hostname) admin> exitmode
configname(hostname)>

Alternatives

No response

Anything else?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!

Contributor guide

Tech stack
javashell
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java developmentUnderstanding of Pulsar shell architectureBasic knowledge of command line interfacesFamiliarity with shell prompt handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by examining the pulsar shell module in the Apache Pulsar repository, specifically the classes handling interactive shell commands. Look at how existing commands are registered and executed, likely in a class like InteractiveShell or ShellCommands. The feature requires adding 'admin' and 'client' as special commands that change the command prefix state, and an 'exitmode' command to reset. Check the prompt formatting logic to ensure the mode indicator is correctly displayed. There are no linked PRs or comments, so the implementation is open for design. Reference main files such as pulsar shell/src/main/java/org/apache/pulsar/shell/InteractiveShell.java or similar.