webdesserts/projects-cli

A tool for tracking, searching, and jumping to your projects.

projects-cli's Issues

Rework init so `project` and `p` function the same

Allow custom alias

Either implement #5 and drop the p alias, or allow passing an option to init to define your custom alias.

Add `projects groups` subcommand

Right now it's hard to communicate that the path you're adding is not the path to a project, but the path to a group of projects. Consider adding a new projects groups command that could separate commands specific to those root paths. Current ideas on commands:

• projects groups add .
• projects groups remove .
• projects groups list.
• projects list
• projects select

Add documentation on crates.io

Fix broken bash output

For some reason when there are 3 or more arguments when get some bash jank as follows:

projects:[:1: too many arguments

Please fix that

Preview added projects before tracking a project folder

When a user runs project track add an explainer that this will add projects in this folder and preview what projects will be included.

Git integration

I'm not sure how to handle this quite yet, but we could add git integration in a few ways:

• We could limit project select to only return folders that have been initialized as .git repositories.
• We could potentially recursively search a directory for .git folders, instead of only doing a shallow search.
• This could be the default and the full folder search could be optional, though I wouldn't do this in combination with the recursive search.
• We could display details about the current branch and tag when searching (maybe TMI?)

Right now I'm leaning toward shallow search that looks for git directories by default. We could then pass an optional argument that also lists normal directories. Not entirely sure what the best UX here would be.

Add `config` api to list out path to config

Add `project select`

Lets add a project select command that allows users to take advantage of the project fuzzy finder for purposes other than cd.

Sort `projects list`

Add command aliases

I usually prefer verbose command names, but in some cases the aliases are so common that it hurts the ux if we don't have them:

• projects list -> projects ls
• projects remove -> projects rm

Display paths as home relative

• projects list
• projects remove
• projects select (the side information)

projects init command

https://github.com/starship/starship/tree/master/src/init

Starship has an interesting way of initing the cli via a bash script. I would love to dig into this and simplify the shell setup for project-cli as well.

Consider renaming `config.paths` to `config.roots`

Add Readme

Add a Readme with the following:

• Short description
• Installation
• Basic Usage
• List of commands

Add link to crates.io

Or a badge, whatever

Add ability to select from list with `remove` command

When a user calls projects remove with no path argument, we should list off the current folders being tracked.

Explore using dialoguer to improve ux of `track` command

https://docs.rs/dialoguer/0.5.0/dialoguer/

Publish to brew

Right now even though cargo install projects is a real quick install, if you've never used cargo install before I'm pretty sure you still have to...

1. Install rust
2. Add ~/.cargo/bin to your path

This is still a good bit of extra setup, so it kind defeats the original goal of a (quick and easy setup) for anyone who doesn't already use rust bins. I should at the very least document this as "pre-requisites", but another solution would be to figure out how to publish this to brew. I know there's a cargo-brew crate, but that seems a bit unmaintained and only seems to set things up locally. In general I just need to do more research on what it takes to get a tap published.