Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,31 @@ Issues and feature requests are welcome to the repo.

## 💡 Command line usage

### Installation: Non mac

```bash
pip install gitingest
```

### Installation: Mac

99% of mac users use `brew` as a local package manger.
If Python and pip have been installed with `brew`, it is recommended to stay in this ecosystem with `pipx`.
**If `pipx` does not exist and you are using `brew`, first install the following:**

```bash
brew install pipx
pipx ensurepath
```

Finally, install `gitingest`:

```bash
pipx install gitingest
```

### Usage

The `gitingest` command line tool allows you to analyze codebases and create a text dump of their contents.

```bash
Expand Down
Loading