dev

module
v0.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2020 License: MIT

README

That Dev Tool

pipeline status github tag (latest semver) maintainability test coverage

A CLI tool for improving the developer experience.

Onboarding

  • Software checks to verify required software is installed
  • Network checks to verify required connectivity is established
  • Link directory to quickly access project-related URLs

Development

  • Receive notifications on todos/work from common developer platforms (Gitlab, Pivotal Tracker)
  • Receive notifications on your desktop, or on Telegram
  • Open repository website using the default browser

Installation

Releases are available on Github at https://github.com/zephinzer/dev/releases.

You can also install it via go install:

go install github.com/zephinzer/dev

Test the installation works by running dev -v.

Usage

dev loads its configuration from ~/dev.yaml where ~ is your home directory. It also searches for a local ./dev.yaml in your current working directory and if found, merges it with the global configuration.

Software checks

Setting up software checks
Using software checks
dev check software;

Network checks

Setting up network checks
Using network checks
dev check networks;
dev goto;

Platform integrations

Github
Setting up Github integration
Using the Github integration
dev get github account;
dev get github notifs;
Gitlab
Setting up Gitlab integration
Using the Gitlab integration
dev get gitlab account;
dev get gitlab notifs;
Pivotal Tracker
Setting up Pivotal Tracker integration
Using the Pivotal Tracker integration
dev get pivotal account;
dev get pivotal notifs;
Trello
Setting up Trello integration
Using the Trello integration
dev get trello account;
dev get trello notifs;

Notification integrations

Telegram

dev is able to notify you via Telegram if the integration has been set up.

Setting up Telegram notifications integration
  1. Talk to The BotFather using /start if you haven't talked to it before.
  2. Send the /newbot command to create a new bot. Give your bot a logical name (eg. "My Notification Bot") followed by a bot username (eg. my_notification_bot).
  3. You should receive an access token of the form 1234556789:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX, add the access token at the property dev.client.notifications.telegram.token.
  4. Run dev init telegram notifs
  5. Talk to your bot and you should see a chat ID appear in dev's logs
  6. Copy and paste this chat ID to the property dev.client.notifications.telegram.id as a string (surround the ID with quotes)
  7. To test the integration, ensure your chat ID is in the configuration, and run dev debug notifications and confirm you receive a notification in Telegram

Your configuration should look like:

# ... other properties ...
dev:
  # ... other properties ...
  notifications:
    telegram:
      token: 1234556789:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
      id: "987654321"
# ... other properties ...

Contributing

License

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

Directories

Path Synopsis
cmd
dev
internal
config
Package config defines the structure of the configuration for the `dev` tool.
Package config defines the structure of the configuration for the `dev` tool.
constants
Package constants consists of constants used throughout the `dev` tool.
Package constants consists of constants used throughout the `dev` tool.
db
log
pkg
github
Package github contains methods and structures that help with the consumption of the Github API.
Package github contains methods and structures that help with the consumption of the Github API.
gitlab
Package gitlab contains methods and structures that help with the consumption of the Gitlab API.
Package gitlab contains methods and structures that help with the consumption of the Gitlab API.
trello
Package trello exposes methods that can be used to interact with the Trello REST API.
Package trello exposes methods that can be used to interact with the Trello REST API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL