https://github.com/gennaro-tedesco/archimede

💡 Unobtrusive directory information fetcher
https://github.com/gennaro-tedesco/archimede

cli command-line go screenfetch

Last synced: 2 months ago
JSON representation

💡 Unobtrusive directory information fetcher

• Host: GitHub
• URL: https://github.com/gennaro-tedesco/archimede
• Owner: gennaro-tedesco
• License: apache-2.0
• Created: 2021-05-30T08:58:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-05T09:07:27.000Z (over 1 year ago)
• Last Synced: 2024-08-04T04:05:36.705Z (5 months ago)
• Topics: cli, command-line, go, screenfetch
• Language: Go
• Homepage:
• Size: 86.9 KB
• Stars: 41
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-fetch - archimede - Unobtrusive project information fetcher. `Go` (Operation System / Cross Platform)

README

        


  


  

  


  archimede





  

    

  

  

    

  

  

    

  



Unobtrusive project information fetcher



  Installation •

  Usage •

  Examples



The unobtrusive, fast and informative project information fetcher. Whether it is a new git project or old legacy code, visualise a quick summary of directory structure, files composition, disk space and status.

## Installation

Go get it!

```

go install github.com/gennaro-tedesco/archimede@latest

```

## Usage

![demo](https://user-images.githubusercontent.com/15387611/120531489-f970b000-c3de-11eb-8965-2efca47fe8c1.gif)

Various flags allow to customise the output: see `archimede --help` for full details or examples below

| flag             | type   | description                               | default

|:---------------- |:------ |:----------------------------------------- |:-------

| -s/--short       | bool   | display output in short format?           | false

| -g/--git         | bool   | include `./.git` folder in files stats?   | false

| -e/--exclude-dir | string | directory to exclude from stats/counts    | none

| -v/--exclude-file| string | file type to exclude from stats/counts    | none

| -c/--colour      | string | choose display text color (see `--help`)  | cyan

| -d/--delimiter   | string | choose delimiter character                | empty string

| -h/--help        |        | open the help page                        |

Notice that the default display option in long format (no `-s` flag) makes use of unicode

terminal characters that may not render perfectly with all terminals/fonts: if so use `-s`.

## Examples

```

# short format, blue text

archimede -s -c blue

# change delimiter, exclude test folder

archimede -d":" -e test

# short format, exclude .vim files

archimede -s -v .vim

# display help page

archimede --help

```

## Feedback

If you find this application useful consider awarding it a ⭐, it is a great way to give feedback! Otherwise, any additional suggestions or merge request is warmly welcome!