Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kostiantyn-matsebora/workspace-cli
CLI that provides functionality for installing and configuring workspace for a software engineer/DevOps.
https://github.com/kostiantyn-matsebora/workspace-cli
automation bash cli containerization devops git github kubernetes kubernetes-cluster linux vscode workspace
Last synced: 17 days ago
JSON representation
CLI that provides functionality for installing and configuring workspace for a software engineer/DevOps.
- Host: GitHub
- URL: https://github.com/kostiantyn-matsebora/workspace-cli
- Owner: kostiantyn-matsebora
- License: mit
- Created: 2024-09-02T08:08:56.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-11-10T15:33:41.000Z (about 2 months ago)
- Last Synced: 2024-11-10T16:32:11.807Z (about 2 months ago)
- Topics: automation, bash, cli, containerization, devops, git, github, kubernetes, kubernetes-cluster, linux, vscode, workspace
- Language: Shell
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# Workspace CLI
Workspace CLI is a bash script that provides functionality for installing and configuring workspace for a software engineer/DevOps working with containers and orchestration on a Linux environment.
Functionality includes installation and configuration of the following applications:
- [Git](https://git-scm.com/) and [Github CLI](https://cli.github.com/).
- [Visual Studio Code](https://code.visualstudio.com/).
- Rootless [docker]( https://rootlesscontaine.rs/getting-started/docker/).
- Single node kubernetes: [k3s](https://k3s.io/) or [minikube](https://minikube.sigs.k8s.io/docs/).
- Kubernetes CLI tools like: [kubectl](https://kubernetes.io/docs/reference/kubectl/), [helm](https://helm.sh/), [helmfile](https://github.com/helmfile/helmfile), [vals](https://github.com/helmfile/vals).
Workspace CLI is designed to be used on a Linux environment, and it is tested on Ubuntu 22.04 LTS.
## Installation
To install workspace CLI you simply must do the following steps:
- Download workspace script the destination directory, for instance `$HOME/bin`:
```Bash
mkdir -p $HOME/bin
wget https://raw.githubusercontent.com/kostiantyn-matsebora/workspace-cli/master/release/workspace -O $HOME/bin/workspace
chmod +x $HOME/bin/workspace
```
- Add an alias to your `.bashrc` or `.bash_profile` file:
```Bash
echo "alias workspace='$HOME/bin/workspace'" >> $HOME/.bashrc
```
- Reload your shell:
```Bash
source $HOME/.bashrc
```
# Usage
After installation, you can use workspace CLI by running `workspace` command in your terminal. It will show you a help message with available commands.
```shell
$ workspace
workspace - CLI that provides functionality for installing and configuring workspace for a software engineer/DevOps.
Usage:
workspace COMMAND
workspace [COMMAND] --help | -h
workspace --version | -v
Commands:
completions Generate bash completions
register-autocomplete Register autocompletion for workspace CLI in .bashrc file
upgrade Upgrade workspace CLI to latest version
install Install applications and tools required for workspace. Does not require interactive input, so this command cannot be used in CI/CD environments and automation scripts.
setup Setup (install and configure) workspace. Require interactive input, so this command cannot be used in CI/CD environments and automation scripts.
config Configure workspace. Applications needs to be already installed. Some of steps require interactive input, so this command cannot be used in CI/CD environments and automation scripts.
git Install and configure git toolkit
docker Install rootless docker
howdy Install and configure pluggable authentication module (PAM) howdy for facial recognition
kube Kubernetes installation and configuration
kube-tools Kubernetes CLI tools installation and configuration
vscode Visual Studio Code installation and configuration
vals Install and configure vals
system System maintenance utilities
```
To get help for specific commands you can run: `workspace COMMAND --help`, for instance:
```shell
$ workspace setup --help
workspace setup
Setup (install and configure) workspace. Some of the steps require interactive
input, so this command cannot be used in CI/CD environments and automation
scripts.
Alias: s
```
As an example to install and configure `git` and `GitHub CLI` you can run the following command:
```shell
workspace setup git
```
To install and configure all applications you can run:
```shell
workspace setup all
```
## Development
CLI is generated using [bashly](https://bashly.dannyb.co/), a bash framework for writing CLI applications.
Bashly configuration and sources are located in `bashly` directory.
If you have already installed bashly you can regenerate CLI by running the following command from the destination directory:
```shell
bashly generate
```
or if you already have docker installed you can add the following alias to your `.bashrc` or `.bash_profile` file:
```shell
alias bashly='docker run -it --rm -v $HOME/bin/workspace -w /work dannyben/bashly'
```
and then use bashly command as usual:
```shell
bashly generate
```
For more information how to install bashly you can visit [bashly](https://bashly.dannyb.co/) website.
## Contributing
If you experience any issues, have a question or a suggestion, or if you wish
to contribute, feel free to [open an issue][issues] or
[start a discussion][discussions].
[issues]: https://github.com/kostiantyn-matsebora/workspace-cli/issues
[discussions]: https://github.com/kostiantyn-matsebora/workspace-cli/discussions