codenav

Code Navigation

install it

from stable

npm install -g codenav

from source

git clone [e-mail]:viqueen/codenav.git
cd codenav

npm link

configure it

• view default config

cnav config

• set your custom values

cnav set-config sources.root <path/to/sources/root>
cnav set-config shell.cmd <bash|zsh>

use it

• cnav

>> cnav -h

Options:
  -V, --version                output the version number
  -h, --help                   display help for command

Commands:
  register <sshUrlConnection>  registers a new repo using its ssh url connection
  list [options]               lists registered repos
  clone [options]              clone registered repos
  config                       displays cnav configuration
  set-config <key> <value>     updates cnav configuration entry
  get-config <key>             gets cnav configuration entry
  go <alias>                   go to repo directory
  github <namespace>           register repos from github with given namespace
  bitbucket <namespace>        register repos from bitbucket with given namespace
  help [command]               display help for command

• register repos from bitbucket

cnav bitbucket <username|org>

• register repos from github

cnav github <username|org>

• list repos

usage

Usage: cnav list [options]

lists registered repos

Options:
-h, --host <name> filter by host (default: "_")
-ns, --namespace <namespace> filter by namespace (default: "_")
-l, --location display checkout location only (default: false)

cnav list
cnav list -ns <username|org>
cnav list -h <github.com|bitbucket.org>
cnav list -ns <username|org> -h <github.com|bitbucket.org>

• clone repos

usage

Usage: cnav clone [options]

clone registered repos

Options:
-h, --host <name> filter by host (default: "_")
-ns, --namespace <namespace> filter by namespace (default: "_")

cnav clone
cnav clone -ns <username|org>
cnav clone -h <github.com|bitbucket.org>
cnav clone -ns <username|org> -h <github.com|bitbucket.org>

• navigate to repo

cnav go <name>

:warning: make sure your shell.cmd config is set to the shell you are using (either bash or zsh or ...)