Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/louisgab/devilbox-cli
A minimal cli tool to interact with devilbox from anywhere
https://github.com/louisgab/devilbox-cli
apache bash cli devilbox docker docker-compose lamp lamp-stack mysql php
Last synced: 3 months ago
JSON representation
A minimal cli tool to interact with devilbox from anywhere
- Host: GitHub
- URL: https://github.com/louisgab/devilbox-cli
- Owner: louisgab
- License: mit
- Archived: true
- Created: 2019-03-08T15:38:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-11T09:16:41.000Z (almost 4 years ago)
- Last Synced: 2024-09-24T18:32:34.556Z (3 months ago)
- Topics: apache, bash, cli, devilbox, docker, docker-compose, lamp, lamp-stack, mysql, php
- Language: Shell
- Homepage:
- Size: 69.3 KB
- Stars: 44
- Watchers: 5
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Devilbox CLI
[](https://github.com/louisgab/devilbox-cli/blob/master/LICENSE)
> A simple and conveniant command line to manage devilbox from anywhere
---
## Getting Started
### Requirements
You need [Devilbox](https://github.com/cytopia/devilbox#quick-start) to be installed somewhere on your computer.
By default, the script will use the path `$HOME/.devilbox`.
If you have cloned devilbox somewhere else, add the following to your profile and change `##PATH_TO_DEVILBOX##` accordingly:
```sh
export DEVILBOX_PATH="$HOME/##PATH_TO_DEVILBOX##"
```
Then reload your terminal or run `source ~/.zshrc` if you use zsh.
### Install
As simple as :
```
npm install -g devilbox-cli
```
If installed successfully, you should see something like this when you run `devilbox -v`:
```sh
devilbox-cli v0.4.1 (2020-12-06)
A simple and conveniant cli to manage devilbox from anywhere
https://github.com/louisgab/devilbox-cli
```
#### Alternatives
If you don't have npm or don't wan to use it, you can also download the script directly:
```sh
curl -O https://raw.githubusercontent.com/louisgab/devilbox-cli/master/dist/devilbox-cli.sh
chmod +x devilbox-cli.sh
sudo mv devilbox-cli.sh /usr/local/bin/devilbox
```
This way you can call the script from anywhere, but you won't be able to download updates (that was the point of using npm).
For a manual update, delete it first
```sh
sudo rm /usr/local/bin/devilbox
```
Then re-download the script.
### Usage
devilbox-cli provides all basic command to manage your installation:
```sh
devilbox check # Check your .env
devilbox config # Get and set variables on your .env
devilbox enter # Enter the php container with shell.sh script
devilbox exec # Execute a command in the container
devilbox mysql # Execute a command in the container
devilbox open # Open the devilbox intranet
devilbox run # Start the containers
devilbox stop # Stop all containers
devilbox restart # Stop and rerun all containers
devilbox update # Update to latest devilbox version
```
To see containers current versions defined in devilbox `.env` file, use the `config` command:
```sh
devilbox config --apache --php --mysql
# [!] Apache current version is 2.4
# [!] PHP current version is 7.2
# [!] MySql current version is 5.6
```
It can also list available versions of any container:
```sh
devilbox config --mysql=*
# [!] MySql available versions:
# 5.5
# 5.6
# 5.7
# 8.0
```
And of course, it can change any version:
```sh
devilbox config --php=8.0
# [✔] PHP version updated to 8.0
```
You can also point devilbox to your projects folder:
```sh
devilbox config --www=../Documents/Projects/www
# [✔] Projects path config updated to ../Documents/Projects/wwww
```
And if you dont remember a command, `devilbox help` is your best friend :)
### Optional Configuration
By default, the `run` command will start the default LAMP stack containers `php httpd mysql`. The command can be customized by configuring your desired services via the `$DEVILBOX_CONTAINERS` variable. For example, if you'd like to also run the NOSQL stack, you would define the following:
```sh
export DEVILBOX_CONTAINERS="php httpd mysql redis memcd mongo"
```
Then reload your terminal or run `source ~/.zshrc` if you use zsh.
### Important notes
The script was tested on zsh and bash on linux. Use at your own risk on other platforms.
## Contributing
Highly welcomed! The script only implements the basics I needed for myself (LAMP). It may be useful for others to add missing commands, test it on macOS and Windows, and test in on other shells.
## License
[MIT License](LICENSE.md)