Skip to content

Commit 6415074

Browse files
Make basic README
1 parent 37004cc commit 6415074

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
11
# vv
22

3+
Tool that gives you a clear, terminal-friendly view of your repositories — file trees, language stats, and more, right from the CLI.
4+
5+
## Supported Platforms
6+
- Windows
7+
- Linux
8+
- macOs
9+
10+
## Commands
11+
12+
| Name | Description |
13+
|--------------------------------|---------------------------------------------|
14+
| `setup` | Setups **vv** |
15+
| `fs` | Shows repository filesystem info. |
16+
| `langs` | Shows detailed(tokei) languages statistic. |
17+
| `tree` | Shows filesystem tree of repository. |
18+
| `git` | Shows detailed git info. |
19+
20+
## Setup
21+
22+
After you downloaded binary from **Releases**, it is highly recommended to add directory that contains it to PATH.
23+
24+
Before general using, run:
25+
```shell
26+
vv setup
27+
```
28+
29+
> [!IMPORTANT]
30+
> If you don't want to manually write path to repository everytime, configure repositories folder (`Do you want to locate folder for repositories?`).
31+
> After configuring, instead of `vv langs --path long/path/to/my/repo` you can write `vv langs` and it will suggest selection prompt with found repositories.
32+
33+
---
34+
35+
# Usage
36+
37+
Discover available commands and options:
38+
39+
```shell
40+
vv -h
41+
```
42+
43+
Show more info about a command:
44+
45+
```shell
46+
vv langs -h
47+
```

0 commit comments

Comments
 (0)