reshapr-cli

This is the command line interface for the Reshapr project.

Installing the CLI

npm install -g @reshapr/reshapr-cli

Enabling shell completion

The CLI can generate a completion script for Bash, Zsh, Fish, or PowerShell. For example, enable completion for the current Zsh session with:

source <(reshapr completion zsh)

To enable it permanently, generate the script once and load it from your shell configuration:

mkdir -p ~/.reshapr
reshapr completion zsh > ~/.reshapr/completion.zsh
echo 'source ~/.reshapr/completion.zsh' >> ~/.zshrc

Equivalent generation commands for the other supported shells are:

reshapr completion bash > ~/.reshapr/completion.bash
reshapr completion fish > ~/.config/fish/completions/reshapr.fish
reshapr completion powershell > ~/.reshapr/completion.ps1

Load the generated Bash script from the corresponding shell configuration. Fish discovers scripts in its completions directory automatically.

For PowerShell, load the script from your profile. If you don't have a profile yet, create one first:

if (-not (Test-Path $PROFILE)) { New-Item -ItemType File -Path $PROFILE -Force }
Add-Content $PROFILE '. ~/.reshapr/completion.ps1'

Restart PowerShell, or run . $PROFILE, to load it in the current session.

Running the CLI in dev mode

After cloning the repository, you can run the CLI in development mode using the following commands.

1. First, ensure you have the required dependencies installed. You can do this by running:

npm install

2. Next, you have to start the CLI in development mode using:

npm run dev

This will keep the CLI running and watch for changes in the source code, allowing you to develop and test your changes in real-time.

3. Finally, you have to link the reshapr binary to your JavaScript entrypoint for the CLI:

npm link

Executing some commands

# Login to the reShapr local control-plane server
reshapr login --server http://localhost:5555

# Logout once your job is done.
reshapr logout 

Admin operations

The admin command exposes control-plane administration without requiring a normal user login. Supply the deployment's admin API key with the RESHAPR_ADMIN_API_KEY environment variable:

export RESHAPR_ADMIN_API_KEY='<admin-api-key>'
reshapr admin --server http://localhost:5555 user create jdoe \
  --email [email protected] --password '<password>' \
  --firstname John --lastname Doe

On PowerShell, set the variable for the current session instead:

$env:RESHAPR_ADMIN_API_KEY = '<admin-api-key>'

You can instead pass --admin-api-key <key> after admin; this takes precedence over the environment variable. Avoid placing the key directly on the command line in shared environments because it may be retained in shell history or process listings.

The --server <url> admin option takes precedence over the server saved by reshapr login. A server must be available from one of those sources.

Available operations

# Create an organization, optionally owned by an existing user
reshapr admin organization create acme \
  --description 'Acme organization' --owner jdoe

# Assign organization quotas
reshapr admin quota assign acme --quotas \
  '[{"metric":"gateway-group.count","enabled":true,"limit":3},{"metric":"gateway.count","enabled":true,"limit":3}]'

# Replace all memberships for a user
reshapr admin membership set jdoe --organizations '["acme","shared"]'

# Create a Kubernetes service account valid for every organization
reshapr admin service-account create reshapr-system-operator \
  --k8s-subject 'reshapr-system:reshapr-operator' \
  --allowed-organizations '["*"]' --validity-days 90

The --quotas, --organizations, and --allowed-organizations values are JSON arrays. membership set replaces the user's complete organization membership list. Commands returning a resource also support --output json and --output yaml.