divviup / divviup/divviup-api

cli: put collector credential in a dotfile

Open
#1,073 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
10
Forks
5
Avg merge
2h 41m
Merged PRs (30d)
66

Description

In #1019, we're looking at making it easy and fun to run simple aggregations with Divvi Up with a few command line invocations. One rough edge we have is collector credential handling. We instruct users to do divviup collector-credential generate --save, which will write out something like ./collector-credential-11.json, and then subsequently that same path is passed to divviup api-client collect --collector-credential-file.

It'd be nice if we instead defaulted to storing credentials in files under ~/.divviup/ (or whatever $HOME is on a given OS), akin to how aws-cli will store authentication tokens and config for which token goes with which account in ~/.aws/{config,credentials}.

This could break compatibility with the tool's existing interface (where --save writes the credential to $PWD) but I think there are probably few enough users of this tool out there that we can afford to make incompatible changes.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the divviup collector-credential generate --save and divviup api-client collect --collector-credential-file entry points described in the issue. Determine how credential paths should be selected under the user’s home directory on each supported OS, and how existing path-based usage should be handled. Done means generated credentials are stored and subsequently discoverable under ~/.divviup/.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.