Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raiyanyahya/freshenv
🥗 Provision, share, manage local and cloud developer environments.
https://github.com/raiyanyahya/freshenv
cli command-line developer-tools docker productivity python
Last synced: about 2 months ago
JSON representation
🥗 Provision, share, manage local and cloud developer environments.
- Host: GitHub
- URL: https://github.com/raiyanyahya/freshenv
- Owner: raiyanyahya
- License: mpl-2.0
- Created: 2021-12-19T21:38:32.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T19:10:21.000Z (3 months ago)
- Last Synced: 2024-11-08T03:48:01.896Z (2 months ago)
- Topics: cli, command-line, developer-tools, docker, productivity, python
- Language: Python
- Homepage: https://freshenv.io
- Size: 169 KB
- Stars: 171
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- best-of-python-dev - GitHub - 40% open · ⏱️ 13.10.2023): (Virtual Environments)
- jimsghstars - raiyanyahya/freshenv - 🥗 Provision, share, manage local and cloud developer environments. (Python)
README
[](https://github.com/raiyanyahya/freshenv/actions) [](https://github.com/raiyanyahya/freshenv/actions) [](https://github.com/raiyanyahya/freshenv/actions) [](https://sonarcloud.io/summary/new_code?id=raiyanyahya_freshenv) [](https://github.com/raiyanyahya/freshenv/actions?query=workflow%3ACodeQL) [](https://www.codacy.com/gh/raiyanyahya/freshenv/dashboard?utm_source=github.com&utm_medium=referral&utm_content=raiyanyahya/freshenv&utm_campaign=Badge_Grade) [] [](https://snapcraft.io/freshenv)
[](https://badge.fury.io/py/freshenv) [](https://pypi.python.org/pypi/freshenv/)
# Freshenv 🥗
```freshenv``` is a command line application to provision and manage local developer environments. Build and develop your projects in completely isolated environments. Save, switch and restart your environments. Push and fetch developer environments from the cloud. Choose from a wide variety of flavours to get the developer tools you need.\
\
[](https://gifyu.com/image/Sbsim)
## The Story
This is a solution to a problem I have always had. I like my system to be clean, minimal and structured.
It gets quite tricky to manage multiple projects on my on machine, projects tend to gather and are placed everywhere.
Overtime managing system wide dependencies becomes a problem. It is quite easy to mess up a system setting or to
keep track of a package I wont need tomorrow. This is why I built ```freshenv```. It is a command line application
which helps developers in running and managing completely isolated developer environments locally.
It fetches and lets you run environment flavours in the form of docker containers
which are preconfigured with tools and packages developer needs everyday. Read about the usage below.
I imagine it would help developers like me. I hope you like it.
## Flavours
```freshenv flavours``` are different configurations for freshenv environments. You choose a flavour and provision it as an environment. A flavour can be a combination of operating systems, language packs, tools and application bundles. By default freshenv provisions you with a ```base``` flavour which runs ubuntu 18.04 and has packages like ```wget git python3-pip curl zsh wget nano zsh``` and more. The base flavour is a 260mb environment when provisioned. There are bigger flavours like ```devenv``` which runs on the latest ubuntu and has been loaded and configured with ```docker (run docker inside your freshenv environment), golang, python, node, java, a vscode server, build-essential automake make cmake sudo g++ wget git python3-pip curl zsh wget nano nodejs npm fonts-powerline``` and more. This environment is around 1.6gb large. Freshenv also gives you the option to provision a language based environment which contains necessary developer tools for that language. Checkout the usage section below on the flavours command to see a list of flavours available.
## Custom Environments
Freshenv lets developers build and provision custom environments. A custom flavour is a configuration of the base operating system, packages to install and the command to run when your environment is provisioned. Custom flavours are configured in a config file placed under $HOME/.freshenv/freshenv. This file will be automatically created once you run ```freshenv build config```. Below is an example of a custom flavour.
```yml
[MyEnv]
base=ubuntu
install=apt update -y && apt upgrade -y && apt install arandr
cmd=bash
```
## Cloud Environments
Freshenv cloud introduces cloud capabilities to the developer environments. It lets developers ```push``` and ```fetch``` custom environments to the cloud. It currently supports personal clouds and a freshenv hosting plan is being worked on. To use the cloud features of freshenv you have to configure freshenv with the cloud provider and the bucket name. A sample of the config is present below. It currently supports aws s3 as a provider and more providers are being worked on. Please run ```fr cloud --help``` for more information.
```yml
[cloud.personal]
provider=aws
bucket=myenvironments
aws_profile=default
```
## Installation Linux
I recommend using the snap package manager to install freshenv.
```console
snap install freshenv
# give it access to the docker interface
snap connect freshenv:docker docker:docker-daemon
```
If you dont have or use snap, install the freshenv python package from pypi.
```console
pip install freshenv
```
I would recommend using pipx instead of pip to install cli applications on you machine.
## Installation MacOS
I am trying to get freshenv on homebrew-core but I need more stars on the repository for them to accept my pull request. The self hosted tap is available on the repo raiyanyahya/homebrew-freshenv. Install the freshenv python package from a self hosted homebrew tap.
```console
brew tap raiyanyahya/freshenv
brew install freshenv
```
## Usage
```console
Usage: fr [OPTIONS] COMMAND [ARGS]...
A cli to provision and manage local developer environments.
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
build Build a custom freshenv flavour.
check Check system compatibility for running freshenv.
clean Remove all freshenv flavours and environments.
cloud Save and share your custom environments on the cloud.
flavours Show all available flavours for provisioning.
provision Provision a developer environment.
remove Remove a freshenv environment.
start Resume working in an environment.
view View local freshenv managed environments
```
### Commands and Options
**```flavours```**
```console
Usage: fr flavours [OPTIONS]
Show all available flavours for provisioning.
Options:
--help Show this message and exit.
```
**```provision```**
```console
Usage: fr provision [OPTIONS]
Provision a developer environment.
Options:
-f, --flavour TEXT The flavour of the environment. [default: base]
-c, --command TEXT The command to execute at startup of environment.
-p, --ports INTEGER List of ports to forward. [default: 3000]
-n, --name TEXT Name of your environment.
--help Show this message and exit.
```
**```start```**
```console
Usage: fr start [OPTIONS] NAME
Resume working in an environment.
Options:
--help Show this message and exit.
```
**```remove```**
```console
Usage: fr remove [OPTIONS] NAME
Remove a freshenv environment.
Options:
-f, --force Force remove an environment.
--help Show this message and exit.
```
**```view```**
```console
Usage: fr view [OPTIONS]
View local freshenv managed environments.
Options:
--help Show this message and exit.
```
**```check```**
```console
Usage: fr check [OPTIONS]
Check system compatibility for running freshenv.
Options:
--help Show this message and exit.
```
**```clean```**
```console
Usage: fr clean [OPTIONS]
Remove all freshenv flavours and environments.
Options:
-f, --force Force remove freshenv flavours and environments.
--help Show this message and exit.
```
**```build```**
```console
Usage: fr build [OPTIONS] FLAVOUR
Build a custom freshenv flavour.
Options:
-l, --logs Show build logs.
--help Show this message and exit
```
**```cloud```**
```console
Usage: fr cloud [OPTIONS] COMMAND [ARGS]...
Save and share your custom environments on the cloud.
Options:
--help Show this message and exit.
Commands:
config View personal and freshenv cloud configurations.
fetch Download an environment from the cloud.
ls List cloud environments.
push Upload an environment to the cloud.
```
## License
Freshenv is a free for open-source projects, however, if you are using the library for business and commercial projects you could choose to buy me a coffee.
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started. Please adhere to this project's `code of conduct`.
## Contact
Contact me through email at [email protected]