cloudMux

1# cloudMux
2 
3cloudMux provides matching Bash and Fish shortcuts for GitHub CLI, Google Cloud SDK, and Azure CLI on Android Termux and desktop Linux.
4 
5## Requirements
6 
7- Bash 4 or newer, or Fish 3.3 or newer
8- Linux, including Android Termux
9- Any of `gh`, `gcloud`, and `az` that you plan to use
10- Existing authentication through the official CLI commands
11 
12cloudMux never stores credentials. It reads the current shell environment and leaves authentication to `gh auth`, `gcloud auth`, and `az login`.
13 
14## Install
15 
16From a checkout:
17 
18```bash
19./install.sh
20```
21 
22The installer detects Termux or desktop Linux, checks all three CLIs, and asks before installing missing tools when a supported package manager is available. It creates links under `~/.config/cloudmux`, adds a Bash loader to `~/.bashrc.d`, and adds Fish functions to `~/.config/fish`.
23 
24For a remote install, download the installer and run it with the repository
25URL:
26 
27GitHub:
28 
29```bash
30curl -fsSL https://raw.githubusercontent.com/bitzzdev/cloudMux/dev/install.sh \
31  -o /tmp/cloudmux-install.sh
32CLOUDMUX_REPO_URL=https://github.com/bitzzdev/cloudMux.git \
33  bash /tmp/cloudmux-install.sh
34```
35 
36GitLab:
37 
38```bash
39curl -fsSL https://gitlab.com/bitzzdev/cloudMux/-/raw/dev/install.sh \
40  -o /tmp/cloudmux-install.sh
41CLOUDMUX_REPO_URL=https://gitlab.com/bitzzdev/cloudMux.git \
42  bash /tmp/cloudmux-install.sh
43```
44 
45The installer clones only the repository named by `CLOUDMUX_REPO_URL`. Remove
46the downloaded script after installation if it is no longer needed.
47 
48After installation, start a new shell or source the loader:
49 
50```bash
51source ~/.bashrc.d/cloudmux.bash
52```
53 
54Fish loads the functions from its next interactive session.
55 
56## Usage
57 
58Each domain has a help command:
59 
60```bash
61cloud-help
62gh-help
63gcloud-help
64az-help
65```
66 
67Example:
68 
69```bash
70gh-who
71gc-set-proj my-project
72az-rg-ls
73```
74 
75Help output uses the columns `Alias / Function Name`, `Full Command Executed`, and `One-line Description`. Commands fail clearly when their CLI is not installed.
76 
77## Configuration
78 
79cloudMux has no required configuration file and does not read `.env` files.
80 
81| Variable | Default | Purpose |
82| --- | --- | --- |
83| `TERMUX_VERSION` | unset | Used to identify Termux |
84| `CLOUDMUX_REPO_URL` | unset | Source repository for the remote installer |
85| `CLOUDMUX_INSTALL_DIR` | `~/.config/cloudmux` | Installation directory |
86| `CLOUDMUX_NO_INSTALL` | unset | Set to `1` to skip offers to install missing CLIs |
87 
88The installer also respects the existing `PATH`, `HOME`, `SHELL`, and package-manager settings.
89 
90## Authentication
91 
92Use the official tools directly:
93 
94```bash
95gh-in
96gcloud auth login
97az login
98```
99 
100Do not put tokens in shell startup files, `.env` files, aliases, or issue reports.
101 
102## Common problems
103 
104If a function reports that a CLI is missing, install that CLI with its official package instructions, then start a new shell. If a command reports an authentication error, authenticate with the provider's official command and retry.
105 
106If the functions do not appear, check that `~/.bashrc` or Fish's config is loaded by the shell you started.
107 
108## Contributing
109 
110See [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and [SECURITY.md](SECURITY.md).
111 
112## License
113 
114The license is not selected yet. Choose one before publishing: MIT, Apache-2.0, GPL-3.0, or a proprietary notice.
115