https://github.com/shreyammaity/shreyam-do
A cli tool with to simplify vm setups for debian based linux.
https://github.com/shreyammaity/shreyam-do
debian-packages linux ubuntu-packages
Last synced: 3 months ago
JSON representation
A cli tool with to simplify vm setups for debian based linux.
- Host: GitHub
- URL: https://github.com/shreyammaity/shreyam-do
- Owner: ShreyamMaity
- License: apache-2.0
- Created: 2023-02-18T04:36:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-19T02:26:44.000Z (over 3 years ago)
- Last Synced: 2025-08-31T10:37:49.764Z (10 months ago)
- Topics: debian-packages, linux, ubuntu-packages
- Language: Makefile
- Homepage:
- Size: 29.3 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#
Shreyam-do
---
> A CLI tool to simplify the process of configuring vms for me.
> to install run `curl -sSL https://get.shreyamdo.shreyam.dev/ | bash`
---
## `TLDR:` This tool is for me and it might not be useful for you. But if you want to use it, you can.
---
### Options
```dotnetcli
shreyam-do - Shreyam's setup scripts
Usage: shreyam-do [options]
Options:
[command] Run a specific setup script
-h, --help Display this help message
-v, --version Display version information
-s, --setup Set up the system with all the required packages
-r, --remove Remove all installed packages
```
---
### How to use
- `shreyam-do -s` - installs all the required packages on a fresh vm and configure with npm, zsh, autosuggestions etc.
- `shreyam-do -r` - removes all the packages installed by the tool
- `shreyam-do -v` - displays the version of the tool
- `shreyam-do -h` - displays the help message and the options available
- `shreyam-do ` - runs the specific command
---
### Commands Available
- `shreyam-do doker-setup` - installs docker and docker-compose on the vm and enables http and https ports from firewall
- `shreyam-do enable-overcommit` - enables overcommit which helps with memory issues on virtual machines
- `shreyam-do ssl-nginx ` - generates ssl certificate for the domain from letsencrypt and automatically configures nginx to serve the domain with ssl
- `shreyam-do ssl-cert ` - generates ssl certificate for the domain from letsencrypt and saves it in `/etc/letsencrypt/live/`
- `shreyam-do open-ports` - opens necessary ports for nginx on firewall
- `shreyam-do symLink ` - creates a symlink of the conf file in nginx
---
### How to contribute
- Create an issue if you find any bug or want to suggest a feature
- Fork the repo and create a PR if you want to contribute
---
### License
#### Apache License 2.0
---
### Author
#### [Shreyam Maity](https://shreyam.dev)
---