https://github.com/ewen-lbh/fsorg

Makes directories from a hierarchy-describing text file
https://github.com/ewen-lbh/fsorg

Last synced: 21 days ago
JSON representation

Makes directories from a hierarchy-describing text file

• Host: GitHub
• URL: https://github.com/ewen-lbh/fsorg
• Owner: ewen-lbh
• License: unlicense
• Created: 2019-03-16T11:09:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T13:26:45.000Z (10 months ago)
• Last Synced: 2024-08-08T17:30:04.302Z (3 months ago)
• Language: Ruby
• Homepage: https://rubygems.org/gems/fsorg
• Size: 703 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



  

  
fsorg

  
A file format to describe and create directory structures



## Installation

```console

$ gem install fsorg

```

## Usage

```console

Usage:

    fsorg [options] 

    fsorg [options]  

Options:

    -h --help                 Show this screen.

    -v --version              Show version.

    -r --root=ROOT_DIRECTORY  Set the root directory.

```

## fsorg file format

The text file that describes the folder structure to create is written using this format

```

# This is a comment

ROOT /mnt/d/documents/new-organization-root

projects {

    playgrounds

    staging-area

}

resources {

  icons

  samples

  VSTs

  overlays

  textures

  fonts

  logos

  MIDIs

    ISOs

    installers

}

gaming {

  mods {

    minecraft

  }

  graphics {

    minecraft

  }

  shaders {

    minecraft

  }

  maps {

    minecraft

  }

}

music

images {

    gems

  memes {

    oc

    weeb

    dev

    misc

    templates

  }

  screenshots {

    keep

  }

    wallpapers {

        dual-screen

        phone

        wide

    }

}

documents {

  administrative

  cheatsheets

}

installed

installers {

    windows

    linux

}

```

example.fsorg

Running `fsorg example.fsorg` will create this hierarchy inside `/mnt/d/documents/new-organization-root`:

```

├── documents

│   ├── administrative

│   └── cheatsheets

├── gaming

│   ├── graphics

│   │   └── minecraft

│   ├── maps

│   │   └── minecraft

│   ├── mods

│   │   └── minecraft

│   └── shaders

│       └── minecraft

├── images

│   ├── gems

│   ├── memes

│   │   ├── dev

│   │   ├── misc

│   │   ├── oc

│   │   ├── templates

│   │   └── weeb

│   ├── screenshots

│   │   └── keep

│   └── wallpapers

│       ├── dual-screen

│       ├── phone

│       └── wide

├── installed

├── installers

│   ├── linux

│   └── windows

├── music

├── projects

│   ├── playgrounds

│   └── staging-area

└── resources

    ├── ISOs

    ├── MIDIs

    ├── VSTs

    ├── fonts

    ├── icons

    ├── installers

    ├── logos

    ├── overlays

    ├── samples

    └── textures

```

`ROOT` is not the only command available. See #3, until they are documented here.