README.md

Project

Create npm, cargo, gem or pip project locally and on github or just cd into existing.

After project init you will be prompted to create a github repo (private or public).

You can read more about it in the «Managing your projects» article.

Installation

You will need to install github cli (see this installation instructions) in order to create project repository on github.

With antigen

In your .zshrc

antigen bundle gko/project

Manually

You need to clone repo:

git clone --recursive --depth 1 https://github.com/gko/project

then add it to .bashrc or .zshrc:

source ./project/project.sh

Usage

Usage: project [options]
Example:
  project -p test
Options:
  -h, --help      help
  -p, --private   create private github repository
  -f, --folder    your projects folder(defaults to ~/projects)
  -n, --no-init   avoid initializing package

then to create public repo:

project test

create private repo:

project -p test

If the project exist you will just cd into its folder.

If no name is given you will just cd to projects folder.

If you type project - then you'll jump to previous project folder.

Autocomplete

Supports zsh-autocomplete. On Tab will show the list of available projects.

You can also alias it (in ~/.zshrc or ~/.bashrc):

alias p='project'

to get:

p test-project

Projects path

You can specify projects path by either -f key or $PROJECTS_HOME variable:

project -f /projects_path

or

export PROJECTS_HOME=/projects_path

Otherwise default path is ~/projects

Like it?

⭐ this repo

License

MIT

Copyright (c) 2012-2024 Konstantin Gorodinskiy