package
You're a prolific developer (or you want to be). Manage, keep track of, and show off your projects.
npm install projectsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Project management for power users.
$ npm install -g projectsIf the majority of your projects are subdirectories of one folder then the
easiest way to get started is this (in my case my projects live underneath
~/p/):
$ npm install -g projects
$ echo "alias p=projects" >> ~/.bashrc
$ source ~/.bashrc
$ vim ~/.config/projects
# edit like so (note: this file will probably become JSON soon!)
[github]
username = beaugunderson
[projects]
directory = ~/p
$ p import ~/p/*
$ p github # if you want to import metadata about your GitHub projects tooTry p remind, p git-status, p git-unpushed, and p not-git for examples
of the time savings and management functionality I'm trying to enable.
Note that the color scheme currently assumes a dark background; if you find it
hard to read try DISABLE_COLOR=true in your environment (a revamp of all
colors is coming in the next version).
For autocompletion you can redirect projects --completion to a file in
~/.bash_completion (zsh is also supported) or use projects-modified.sh
which also contains a fallback to _filedir so that you can still complete
files and directories (I've opened an
issue to get that improvement back
into omelette, the completion library we use).
| Command | Description |
|---|---|
alias | output shell aliases |
clone | git clone a project |
each | run a command in each project directory |
edit | edit projects files |
gc | compact the projects database |
get | get an attribute for a project |
git-status | git status across all repositories |
git-unpushed | display repositories with unpushed commits |
github | fill your projects database with your GitHub repositories |
glob | glob across all project directories |
Projects is primarily a framework for making it easy to execute actions on one or more of your projects. For example, you could write a command to check the clean/dirty status of all of your checked out git repositories and list the dirty ones.
If you have an executable file in your PATH that starts with projects- then
you can execute it underneath projects (and you're encouraged to share them
with others!)
$ alias p=projects
$ cat ~/.config/projects
[github]
username = beaugunderson
[projects]
directory = ~/p
$ p info vim-scss-instead
{
"name": "vim-scss-instead",
"repository": "https://github.com/beaugunderson/vim-scss-instead.git",
"language": "VimL",
"role": "creator",
"released": true,
"status": "inactive"
}
$ p set vim-scss-instead homepage https://github.com/beaugunderson/vim-scss-instead
Set vim-scss-instead:homepage to
You can also use something like fzf to make selecting a project via the CLI very easy:
contract-home() {
sed "s|^$HOME|~|"
}
# cd to a project via fzf
pd() {
cd $(projects ls -1 | \
fzf --query="$1" | \
xargs -I {} projects get --porcelain "{}" directory)
}
# open a project's URL via fzf
po() {
open $(projects ls -1 | \
fzf --query="$1" | \
xargs -I {} projects get --porcelain
import | import a directory into projects |
info | show the JSON for a given project |
json-in | import your projects from plain JSON |
json-out | export your projects to plain JSON |
ls | list your porojects |
open | open a project's homepage |
not-git | list projects not in git |
query | query your projects |
remind | get a reminder of what you were last working on |
set | set an attribute to a given value for a project |
Estimated unpacked size across 65 packages.
13.2 MB+
Includes dependencies.
1.1.3
~0.3.3
1.0.1
^2.2.15
7.0.14
~3.7.0
4.18.1
~0.5.0
3.0.1
~2.10.2
2.31.0
^1.0.1
1.0.1
~2.55.0
2.88.2
~0.5.0
2.1.1
git+https://github.com/beaugunderson/node-helmsman.git
2.0.1
^0.3.1
0.4.17
^1.1.8
2.0.3
~2.8.0
15.1.0
^0.1.1
1.0.0
^4.0.1
10.0.0
0.0.3
0.0.3
~0.1.1
0.1.1
~0.1.6
0.1.7
git+https://github.com/beaugunderson/lodash-deep.git
2.0.0
0.0.2
0.0.2
^1.3.1
11.0.0