Skip to content

amerryma/spaceship-supabase

Repository files navigation

🗲 + 🚀
Supabase Section

A Supabase section for Spaceship prompt

GitHub Release GitHub Workflow Status Spaceship Twitter Chat on Discord

Current Supabase project reference, using the project-ref file (🗲).

Installing

You need to source this plugin somewhere in your dotfiles. Here's how to do it with some popular tools:

Execute this command to clone this repo into Oh-My-Zsh plugin's folder:

git clone https://github.com/amerryma/spaceship-supabase.git $ZSH_CUSTOM/plugins/spaceship-supabase

Include spaceship-supabase in Oh-My-Zsh plugins list:

plugins=($plugins spaceship-supabase)
zplug "amerryma/spaceship-supabase"
antigen bundle "amerryma/spaceship-supabase"
antibody bundle "amerryma/spaceship-supabase"
zinit light "amerryma/spaceship-supabase"
zgen load "amerryma/spaceship-supabase"
[plugins.spaceship-supabase]
github = "amerryma/spaceship-supabase"

Manual

If none of the above methods works for you, you can install Spaceship manually.

  1. Clone this repo somewhere, for example to $HOME/.zsh/spaceship-supabase.
  2. Source this section in your ~/.zshrc.

Example

mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/amerryma/spaceship-supabase.git "$HOME/.zsh/spaceship-supabase"

For initializing prompt system add this to your .zshrc:

source "~/.zsh/spaceship-supabase/spaceship-supabase.plugin.zsh"

Usage

After installing, add the following line to your .zshrc in order to include Supabase section in the prompt:

spaceship add supabase

Options

This section is shown only in directories within a supabase context.

Variable Default Meaning
SPACESHIP_SUPABASE_SHOW true Show current section
SPACESHIP_SUPABASE_PREFIX $SPACESHIP_PROMPT_DEFAULT_PREFIX Prefix before section
SPACESHIP_SUPABASE_SUFFIX $SPACESHIP_PROMPT_DEFAULT_SUFFIX Suffix after section
SPACESHIP_SUPABASE_SYMBOL 🗲· Character to be shown before version
SPACESHIP_SUPABASE_COLOR yellow Color of section

Contributing

First, thanks for your interest in contributing!

Contribute to this repo by submitting a pull request. Please use conventional commits, since this project adheres to semver and is automatically released via semantic-release.

License

MIT © Aaron Merryman

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages