Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pocketenv-io/pocketenv

Manage your development environment with ease ✨
https://github.com/pocketenv-io/pocketenv

command-line-tool deno deno-kv dev-env dev-environment-setup dev-workspace developer-tools development-environment development-environment-manager docker nix terraform typescript

Last synced: 3 months ago
JSON representation

Manage your development environment with ease ✨

Host: GitHub
URL: https://github.com/pocketenv-io/pocketenv
Owner: pocketenv-io
License: mpl-2.0
Created: 2024-02-02T18:47:44.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-08-20T12:50:08.000Z (5 months ago)
Last Synced: 2024-09-30T07:24:13.786Z (4 months ago)
Topics: command-line-tool, deno, deno-kv, dev-env, dev-environment-setup, dev-workspace, developer-tools, development-environment, development-environment-manager, docker, nix, terraform, typescript
Language: TypeScript
Homepage:
Size: 294 KB
Stars: 26
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![pokeball](https://cdn3.emoji.gg/emojis/pokeball.png)](https://emoji.gg/emoji/pokeball)

# Pocketenv

[![FlakeHub](https://img.shields.io/endpoint?url=https://flakehub.com/f/pocketenv-io/pocketenv/badge)](https://flakehub.com/flake/pocketenv-io/pocketenv)

[![discord](https://img.shields.io/discord/1270021300240252979?label=discord&logo=discord&color=5865F2)](https://discord.gg/RxKa62YAs4)

[![built with nix](https://img.shields.io/badge/Built_With-Nix-5277C3.svg?logo=nixos&labelColor=73C3D5)](https://builtwithnix.org)

[![deno module](https://shield.deno.dev/x/pocketenv)](https://deno.land/x/pocketenv)

![deno compatibility](https://shield.deno.dev/deno/^1.37)

[![ci](https://github.com/pocketenv-io/pocketenv/actions/workflows/ci.yml/badge.svg)](https://github.com/pocketenv-io/pocketenv/actions/workflows/ci.yml)

Pocketenv is a simple and lightweight tool to manage development workspace environments. It allows you to define and manage workspaces for your projects, and easily switch between them.

![preview](./.github/images/preview.png)

> [!NOTE]

> * `Pocketenv Workspaces` are just Docker Containers with some preinstalled tools, volumes, and [vscode tunnel](https://code.visualstudio.com/docs/remote/tunnels) as an entry point.

> * `Pocketenv Templates` are just Github Repositories with terraform files to create a new workspace.

> [!IMPORTANT]

> Pocketenv is still in development and not ready for production use.

## 🚚 Installation

With Bash:

```bash

curl -fsSL https://cli.pocketenv.io | bash

```

With [Homebrew](https://brew.sh/) (macOS/Linux):

```sh

brew install pocketenv-io/tap/pocketenv

```

With Deno:

```bash

deno install -A -r https://cli.pocketenv.io -n pocketenv

```

With Nix:

```bash

nix profile install --experimental-features "nix-command flakes" github:pocketenv-io/pocketenv

```

Or download the binary from the [releases page](https://github.com/pocketenv-io/pocketenv/releases) and add it to your PATH.

> [!TIP]

> * Quickly create a new workspace with `pocketenv init` and `pocketenv up` command.

> * Destroy it with `pocketenv down` command.

> * List all workspaces with `pocketenv list` command.

> * Start a shell in a workspace with `pocketenv shell` command.

## 🚀 Usage

```bash

pocketenv --help

Usage:   pocketenv

Version: 0.1.3    

Description:

                                                                         

  .                                                                      

       ____             __        __                                     

      / __ \____  _____/ /_____  / /____  ____ _   __                    

     / /_/ / __ \/ ___/ //_/ _ \/ __/ _ \/ __ \ | / /                    

    / ____/ /_/ / /__/ ,< /  __/ /_/  __/ / / / |/ /                     

   /_/    \____/\___/_/|_|\___/\__/\___/_/ /_/|___/                      

                                                                         

    https://pocketenv.io - Manage your development environment with ease.

                                                                         

Options:

  -h, --help     - Show this help.                            

  -V, --version  - Show the version number for this program.  

Commands:

  init   [name]       - Generate a new Pocketenv workspace      

  up     [workspace]  - Start the Pocketenv workspace           

  down   [workspace]  - Stop the Pocketenv workspace            

  list                - List all Pocketenv workspaces           

  shell  [workspace]  - Start a shell in the Pocketenv workspace

```