codenav

Code Navigation

---

I wrote this tool to help me structure and work with the various code-bases I contribute to regardless of which organisations they belong to. This is extremely handy for someone involved in open source development.

It brings in the concept of workspaces, and also persists that into a configuration that can be shared across multiple computers. This is amazing as I often work from either my personal or my company’s laptop, and also I like to spoil myself with new laptops every now and then … with this tool I can simply get setup with cnav clone and it gets me all the code !

It supports registering repositories from different source control providers GitHub, Bitbucket (cloud and DC) … with more providers to come … whenever I have to contribute to a repo hosted over there

The main feature I wrote this tool for is the cnav exec command, it lets you run a script across multiple repositories; this is excellent when you’re working on platform/infrastructure, and you’re generally in need to apply updates in bulk.

---

install it

from stable

• through npm

npm install -g codenav

• through Homebrew

brew tap viqueen/codenav
brew install codenav

from source

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

npm ci
npm run ci:build
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 cnav.workspace <default>
cnav set-config github.username <username>
cnav set-config github.personal.token <token>

---

use it

• available commands

>> cnav --help

Options:
  -w, --workspace <name>                 filter by workspace (default: "default")
  -h, --host <name>                      filter by host
  -ns, --namespace <name>                filter by namespace
  -s, --slug <name>                      filter by name/slug
  -k, --keyword <keyword>                filter by keyword
  -V, --version                          output the version number
  --help                                 display help for command

Commands:
  config                                 displays cnav configuration
  set-config <key> <value>               updates cnav configuration entry
  get-config <key>                       gets cnav configuration entry
  register <urlConnection> [aliases...]  registers a new repo using its url connection
  list                                   lists registered repos
  remove                                 removes registered repos
  clone                                  clone registered repos
  exec <executableFile> [args...]        execute script on target repos
  stash <project>                        register repos from stash for a given project
  bitbucket <namespace>                  register repos from bitbucket with given namespace
  github --user <namespace>              register repos from github with given user namespace
  github --org <namespace>               register repos from github with given org namespace
  help [command]                         display help for command

• register repos from bitbucket

cnav bitbucket <username|org>

• register repos from bitbucket server

cnav stash <projectKey>

• register repos from GitHub

cnav github --user <username>
cnav github --org <organisation>

• list repos

usage

Usage: cnav list [options]

lists registered repos

Options:
  -w, --workspace <name>                 filter by workspace (default: "default")
  -h, --host <name>                      filter by host
  -ns, --namespace <name>                filter by namespace
  -s, --slug <name>                      filter by name/slug
  -k, --keyword <keyword>                filter by keyword

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

• clone repos

usage

Usage: cnav clone [options]

clone registered repos

Options:
  -w, --workspace <name>                 filter by workspace (default: "default")
  -h, --host <name>                      filter by host
  -ns, --namespace <name>                filter by namespace
  -s, --slug <name>                      filter by name/slug
  -k, --keyword <keyword>                filter by keyword

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

---

develop it

• run and watch tests with npm test
• run the cli with local changes using ./cnavdev <options> <commands>