Project-Env Shell logo

Project-Env Shell Project-Env

Use this command to install Project-Env Shell:
winget install --id=ProjectEnv.ProjectEnvShell -e

The Project-Env Shell integration application allows to use tools setup by the Project-Env CLI in a shell environment.

Project-Env Shell is a utility designed to integrate tools configured by Project-Env CLI into shell environments. It simplifies access to project-specific tools and configurations directly within your development workflow.

Key Features:

  • Cross-shell support for Unix and Cygwin environments, ensuring consistent tool management across different platforms.
  • Automation of environment setup through script creation, reducing manual configuration steps.
  • Compatibility with IntelliJ Terminal, enabling seamless integration into existing development setups.

Audience & Benefit:
Ideal for developers and teams working on multiple projects, Project-Env Shell streamlines the process of managing project-specific tools and environments. It provides a consistent and efficient way to set up your shell environment across different platforms, enhancing productivity by minimizing manual setup efforts. The application can be installed via winget, ensuring smooth integration into your development workflow.

README

Project-Env Shell

Build Quality Gate Status

The Project-Env Shell integration application allows to use tools setup by the Project-Env CLI in a shell environment. See Project-Env for more details.

Installation

Homebrew

brew install --cask project-env/tap/project-env-shell

Winget

winget install ProjectEnv.ProjectEnvShell

Shell integration examples

Unix shell

To use Project-Env managed tools in your unix shell, create the following script:

#!/bin/sh
if [[ ! -f "project-env.toml" ]]; then
    sh
else
  project-env-shell --config-file="project-env.toml" --output-template=sh --output-file=.project-env
  source .project-env
  sh
fi

To use the tools, you now only need to call the script to setup the shell.

For example, if you want to start your IntelliJ Terminal with Project-Env tools setup, configure the following command in the Terminal settings:

/bin/sh --login -c 

Cygwin shell (started through Windows CMD)

To use Project-Env managed tools in your Cygwin shell, create the following script:

@echo off
if not exist project-env.toml (
    bash.exe
) else (
    project-env-shell.exe --config-file=project-env.toml --output-template=cygwin --output-file=.project-env
    dos2unix .project-env
    bash.exe --init-file .project-env
)

To use the tools, you now only need to call the script to setup the shell.

Versions
3.2.0
Website
License