Skip to content

Commit

Permalink
docs: Add a tree sample
Browse files Browse the repository at this point in the history
  • Loading branch information
NoUseFreak committed Jan 9, 2024
1 parent cc4ce6d commit 8fd8ece
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# Project Helper

Project Helper helps you structure your projects on your filesystem.
> Project Helper helps you structure your projects on your filesystem.
If you like your projects to be structured like this, that this CLI tool is for you!

```
❯ tree -L 3 ~/src
/home/dries/src
└── github.com
├── nousefreak
│   ├── projecthelper
│   └── warpdir
└── stenic
├── k8status
└── ledger
```

I use `~/src` as the `basedir` for all my projects.


## Install

Expand All @@ -11,10 +28,11 @@ go install github.com/nousefreak/projecthelper@latest
projecthelper install
```


## Commands

```bash
# Run setup (manages `.config/projecthelper/config.yaml`
# Run setup (manages `.config/projecthelper/config.yaml`
ph setup

# Clone to `${basedir}/github.com/nousefreak/projecthelper`
Expand All @@ -23,19 +41,20 @@ ph clone https://github.com/nousefreak/projecthelper
# Clones all repos (set `GITHUB_TOKEN` to include private)
ph org github.com/nousefreak

# Open a fuzzyfinder that will `cd` to the repo
# Open a fuzzyfinder that will `cd` to the repo
ph go [search]

# Shorthand for `ph go`
ph [search]

# Run a `git fetch` on all repos
ph update
ph update

# Show commits made to any repository in the last 2 days
ph wdid 2 days
```


## Badges

[![Releases](https://img.shields.io/github/v/release/nousefreak/projecthelper?style=for-the-badge)](https://github.com/NoUseFreak/projecthelper/releases)
Expand Down

0 comments on commit 8fd8ece

Please sign in to comment.