dev

README

Dev

Pimp your developer experience.

This tool exists to improve the day-to-day work experience of software developers. Use this to:

1. Improve onboarding process through defining required software in code
2. Improve day-to-day work experience through defining required network connections in code
3. Improve productivity through moving checking/notification activities to the command line

You can:

• ✅ Check if you have required software - dev check software
• ✅ Check if you have required network connectivity - dev check networks
• ✅ Check if you have required repositories - dev check repos
• ✅ Search for and go to links within your project - dev goto
• ✅ Get work assigned to you - dev get work
• ✅ Get notifications from developer platforms - dev get notifications
• ✅ Get notifications on your desktop
• ✅ Get notifications on your telegram
• ✅ Open the website of repository you're in - dev open repo
• ✅ Be l33t by using aliases that become simpler as you use them (example: from dev get notifications to dev get notifs to dev g n)

Table of Contents

• Dev
• Installation
  • Via Git Repository
  • Other Ways
• Usage
  • Overview
  • Table of Canonical Tokens
  • Configuration
  • Platforms
    • Github
      • Setting Up
    • Gitlab
    • PivotalTracker
    • Trello
    • Telegram
• Development Notes
• Licensing

---

Installation

Via Git Repository

Clone this repository and run make install_local.

Other Ways

Coming soon!

---

Usage

Overview

The following is an overview of what can be done:

# check stuff
dev check software; # checks if required software is installed
dev check networks; # checks if required network access is available
dev check repositories; # checks if required repositories are available locally

# retrieving account information 
dev get github account; # from github
dev get gitlab account; # from gitlab
dev get pivotaltracker account; # from pivotal tracker
dev get trello account; # from trello

# retrieve notifications
dev get gitlab notifications; # from gitlab
dev get pivotaltracker notifications; # pivotal tracker
dev get trello notifications; # trello

# retrieve your work 
dev get work pivotaltracker; # from pivotal tracker

# retrieve consumed configuration
dev get config;

# initialise persistent database
dev initialise database;
# initialise telegram notification integration
dev initialise telegram notifications;

# open stuff
dev open repository; # the repository you're currently in

# start stuff
dev start client; # starts the desktop client helper application

Table of Canonical Tokens

Concept	Type	Canon	Aliases
Account	Noun	account	accounts, acc, accs, a
Configuration	Noun	configuration	config, conf, cf, c
Database	Noun	database	db
Gitlab	Noun	gitlab	gl
Github	Noun	github	gh
Network	Noun	network	networks, net, nets, nw
Notifications	Noun	notifications	notification, notif, notifs, n
Repository	Noun	repository	repo, rp, r
PivotalTracker	Noun	pivotaltracker	pivotal, pt
Software	Noun	software	sw, s, apps
Work	Noun	work	stories, tasks, tickets, w
Check	Verb	check	c, verify
Get	Verb	get	retrieve, g
Initialise	Verb	initialise	initialize, init, i
Open	Verb	open	o
Start	Verb	start	st, s

Configuration

See the documentation on Configuration for more information.

Platforms

Github

Setting Up

Retrieve your accessToken by generating a new personal access token from https://github.com/settings/tokens. You'll need the following scopes:

• repo:status
• repo_deployment
• public_repo
• repo:invite
• read:packages
• read:org
• read:public_key
• read:repo_hook
• notifications
• read:user
• read:discussion
• read:enterprise
• read:gpg_key

Gitlab

Retrieve your accessToken by generating a new personal access token from https://gitlab.com/profile/personal_access_tokens. You'll need the following scopes:

• api
• read_api

If you're using an on-premise Gitlab, change gitlab.com to your Gitlab's hostname

PivotalTracker

See the Pivotal Tracker integration for more information.

Trello

See the Trello Integration for more information.

Telegram

See the Telegram Integration for more information.

---

Development Notes

See the documentation on Development Notes for more information.

---

Licensing

Code is licensed under the MIT license. Click here to view the full text.