Skip to content

gbudge/conda-helpers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Conda Environment Helper Suite for Zsh

Overview

This project provides a robust set of Zsh shell functions and aliases to streamline the management of Conda environments. The suite enables fast creation, activation, deletion, listing, resetting, purging, and upgrading of Conda environments directly from your terminal, with user-friendly flags and confirmations.

Key Features

  • Create, activate, delete, and list Conda environments
  • Reset, recreate, and purge environments with single commands
  • Upgrade all packages in an environment
  • Aliases for rapid access
  • Help and force flags for safe, flexible operations

Installation

  1. Prerequisites

    • Zsh shell
    • Conda (Miniconda or Anaconda)
    • Python 3 (installed via Conda)
  2. Setup

    • Copy or symlink helpers/zsh/zsh_aliases into your shell configuration directory (e.g., ~/.zshrc.d/).
    • Add the following line to your .zshrc:
      source /path/to/helpers/zsh/zsh_aliases
    • Restart your terminal or reload your Zsh configuration:
      source ~/.zshrc

Usage Guidelines

All commands support -h/--help for usage info and -f/--force to skip confirmation prompts (where applicable).

Main Functions & Aliases

Create Environment

cc_create myenv
cc_mk myenv
cc_create .

Creates a new Conda environment named myenv (or current directory name with .).

Activate Environment

cc_activate myenv
cc_ac myenv
cc_activate .

Activates the specified environment.

Delete Environment

cc_delete myenv
cc_rm myenv
cc_delete -f myenv

Deletes the specified environment. Use -f to skip confirmation.

List Environments

cc_list
cc_ls

Lists all Conda environments.

Activate Base Environment

cc_base
cc_b

Activates the base Conda environment.

Reset Environment (delete, create, activate)

cc_reset myenv
cc_rs myenv

Recreate Environment (delete + create)

cc_recreate myenv
cc_rc myenv

Recreate & Activate Environment

cc_recreate_activate myenv
cc_rca myenv

Create & Activate Environment

cc_create_activate myenv

Purge All Environments (except base)

cc_purge
cc_p
cc_purge -f

Upgrade All Packages in Environment

cc_upgrade myenv
cc_up myenv
cc_upgrade -f myenv

About / Version

cc_about

Compatibility Matrix

Platform Shell Conda Version Python Version Dependencies
Linux Zsh >=4.7 >=3.6 Miniconda/Anaconda
macOS Zsh >=4.7 >=3.6 Miniconda/Anaconda
Windows (WSL) Zsh >=4.7 >=3.6 Miniconda/Anaconda
  • Not tested on native Windows CMD/Powershell.
  • Requires Zsh and Conda to be installed and available in $PATH.

License

MIT License

About

A robust set of Zsh shell functions and aliases to streamline the management of Conda environments.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors