Skip to content

Start

Package manager based on pip and venv

Usage:

$ Start [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • add: Install packages and add to the dependency...
  • env: Manager environments.
  • init: Use current directory as the project name...
  • install: Install packages in specified dependency...
  • list: Display all installed packages.
  • new: Create a new project and virtual...
  • remove: Uninstall packages and remove from the...
  • show: Show information about installed packages.

Start add

Install packages and add to the dependency file.

Usage:

$ Start add [OPTIONS] PACKAGES...

Arguments:

  • PACKAGES...: Packages to install or display [required]

Options:

  • -D, --dev: Add packages as development dependency
  • -d, --dependency TEXT: Dependency file name. If given a toml file, start will parse 'project.dependencies', else start will parse as requirements.txt. If toml file not exists, it will be created. If not given, start will find 'pyproject.toml' and 'requirements.txt' [default: pyproject.toml]
  • -v, --verbose: Display install details
  • --help: Show this message and exit.

Start env

Manager environments.

Usage:

$ Start env [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • activate: Display the activate command for the...
  • create: Create a virtual environment and install...
  • list: List all virtual environments.

Start env activate

Display the activate command for the virtual environment.

Start will check following path to find the virtual environment:

  • $START_DATA_DIR/<ENV_NAME>

  • $START_DATA_DIR/<ENV_NAME>/.venv

  • $START_DATA_DIR/<ENV_NAME>/.env

  • $START_DATA_DIR/<ENV_NAME>/venv

  • $(pwd)/<ENV_NAME>

  • $(pwd)/<ENV_NAME>/.venv

  • $(pwd)/<ENV_NAME>/.env

  • $(pwd)/<ENV_NAME>/venv

To activate on different shell, use following commands:

  • Powershell: Invoke-Expression (&start env activate )

  • cmd: Not support due to the conflict of start

  • bash/zsh: eval "$(start env activate )"

  • fish: start env activate | source

  • csh/tcsh: eval `start env activate `

Usage:

$ Start env activate [OPTIONS] ENV_NAME

Arguments:

  • ENV_NAME: Name of the virtual environment [required]

Options:

  • --help: Show this message and exit.

Start env create

Create a virtual environment and install specified packages.

Usage:

$ Start env create [OPTIONS] ENV_NAME PACKAGES...

Arguments:

  • ENV_NAME: Name of the virtual environment [required]
  • PACKAGES...: Packages to install or display [required]

Options:

  • -r, --require TEXT: Dependency file name. Toml file or plain text file
  • -f, --force: Remove the existing virtual environment if it exists
  • -v, --verbose: Display install details
  • --with-pip / --without-pip: Install pip in the virtual environment [default: with-pip]
  • --without-upgrade: Don't upgrade core package(pip & setuptools) and all packages to be installed in the virtual environment
  • --without-system-packages: Don't give the virtual environment access to system packages
  • --help: Show this message and exit.

Start env list

List all virtual environments.

Usage:

$ Start env list [OPTIONS]

Options:

  • --help: Show this message and exit.

Start init

Use current directory as the project name and create a new project at the current directory.

Usage:

$ Start init [OPTIONS] PACKAGES...

Arguments:

  • PACKAGES...: Packages to install or display [required]

Options:

  • -r, --require TEXT: Dependency file name. Toml file or plain text file
  • -n, --vname TEXT: Name of the virtual environment [default: .venv]
  • -f, --force: Remove the existing virtual environment if it exists
  • -v, --verbose: Display install details
  • -t, --template TEXT: Template to use for the project
  • --with-pip / --without-pip: Install pip in the virtual environment [default: with-pip]
  • --without-upgrade: Don't upgrade core package(pip & setuptools) and all packages to be installed in the virtual environment
  • --without-system-packages: Don't give the virtual environment access to system packages
  • --help: Show this message and exit.

Start install

Install packages in specified dependency file.

Usage:

$ Start install [OPTIONS]

Options:

  • -r, --require TEXT: Dependency file name. Toml file or plain text file
  • -v, --verbose: Display install details
  • --help: Show this message and exit.

Start list

Display all installed packages.

Usage:

$ Start list [OPTIONS]

Options:

  • -t, --tree: Display installed packages in a tree structure [required]
  • -D, --dev: Add packages as development dependency
  • -d, --dependency TEXT: Dependency file name. If given a toml file, start will parse 'project.dependencies', else start will parse as requirements.txt. If toml file not exists, it will be created. If not given, start will find 'pyproject.toml' and 'requirements.txt'
  • --help: Show this message and exit.

Start new

Create a new project and virtual environment, install the specified packages.

Usage:

$ Start new [OPTIONS] PROJECT_NAME PACKAGES...

Arguments:

  • PROJECT_NAME: Name of the project [required]
  • PACKAGES...: Packages to install or display [required]

Options:

  • -r, --require TEXT: Dependency file name. Toml file or plain text file
  • -n, --vname TEXT: Name of the virtual environment [default: .venv]
  • -f, --force: Remove the existing virtual environment if it exists
  • -v, --verbose: Display install details
  • -t, --template TEXT: Template to use for the project
  • --with-pip / --without-pip: Install pip in the virtual environment [default: with-pip]
  • --without-upgrade: Don't upgrade core package(pip & setuptools) and all packages to be installed in the virtual environment
  • --without-system-packages: Don't give the virtual environment access to system packages
  • --help: Show this message and exit.

Start remove

Uninstall packages and remove from the dependency file.

Usage:

$ Start remove [OPTIONS] PACKAGES...

Arguments:

  • PACKAGES...: Packages to install or display [required]

Options:

  • -D, --dev: Add packages as development dependency
  • -d, --dependency TEXT: Dependency file name. If given a toml file, start will parse 'project.dependencies', else start will parse as requirements.txt. If toml file not exists, it will be created. If not given, start will find 'pyproject.toml' and 'requirements.txt' [default: pyproject.toml]
  • -v, --verbose: Display install details
  • --help: Show this message and exit.

Start show

Show information about installed packages.

Usage:

$ Start show [OPTIONS] PACKAGES...

Arguments:

  • PACKAGES...: Packages to install or display [required]

Options:

  • --help: Show this message and exit.