Documentation Generators

Framed – Files and Directories Reusability, Architecture, and Management

Framed is a CLI tool that simplifies the organization and management of files and directories in a reusable and architectural manner. It provides YAML templates for defining project structures and enables workflows based on those.

At the core of Framed lies its use of YAML templates to define project structures. YAML, a human-readable data serialization format, allows you to specify the desired organization of files and directories within your projects. The structured and declarative nature of YAML empowers you to create reusable templates that can be easily shared and applied across different projects.

By utilizing YAML templates, you can establish a consistent structure for your projects, ensuring that team members adhere to a standardized layout. This standardization minimizes confusion, reduces errors, and promotes efficient collaboration.

This is free and open source software.

Features include:

  • Built-in test command. This command enables you to verify the project structure against the defined YAML template, ensuring that the two remain in sync. By integrating this test command into your CI/CD pipelines, you can automatically validate the project structure as part of your continuous integration process. This eliminates the need for manual checks and ensures that any deviations from the defined structure are caught early on.
  • Range of configuration options to suit your specific project requirements. With the ability to define nested directories, file patterns, forbidden files, and minimum/maximum file counts, you have fine-grained control over the project structure.
  • Distributed as a single binary.
  • Extensibility allows you to adapt the tool to your specific needs. You can import project structures from URLs, making it easy to integrate templates from external sources. Additionally, Framed provides example project structures for popular programming languages like Python and Go, allowing you to kickstart your projects with predefined templates.
  • Docker support.

Website: github.com/mactat/framed
Support:
Developer: Maciej Tatarski
License: MIT License

Framed options

Framed is written in Go. Learn Go with our recommended free books and free tutorials.


Popular series
Free and Open Source SoftwareThe largest compilation of the best free and open source software in the universe. Each article is supplied with a legendary ratings chart helping you to make informed decisions.
ReviewsHundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information.
The Big List of Active Linux Distros is a large compilation of actively developed Linux distributions.
Alternatives to Proprietary SoftwareReplace proprietary software with open source alternatives: Google, Microsoft, Apple, Adobe, IBM, Autodesk, Oracle, Atlassian, Corel, Cisco, Intuit, and SAS.
GamesAwesome Free Linux Games Tools showcases a series of tools that making gaming on Linux a more pleasurable experience. This is a new series.
Artificial intelligence iconMachine Learning explores practical applications of machine learning and deep learning from a Linux perspective. We've written reviews of more than 40 self-hosted apps. All are free and open source.
Guide to LinuxNew to Linux? Read our Linux for Starters series. We start right at the basics and teach you everything you need to know to get started with Linux.
Alternatives to popular CLI tools showcases essential tools that are modern replacements for core Linux utilities.
System ToolsEssential Linux system tools focuses on small, indispensable utilities, useful for system administrators as well as regular users.
ProductivityLinux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine.
AudioSurveys popular streaming services from a Linux perspective: Amazon Music Unlimited, Myuzi, Spotify, Deezer, Tidal.
Saving Money with LinuxSaving Money with Linux looks at how you can reduce your energy bills running Linux.
Home ComputersHome computers became commonplace in the 1980s. Emulate home computers including the Commodore 64, Amiga, Atari ST, ZX81, Amstrad CPC, and ZX Spectrum.
Now and ThenNow and Then examines how promising open source software fared over the years. It can be a bumpy ride.
Linux at HomeLinux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged.
Linux CandyLinux Candy reveals the lighter side of Linux. Have some fun and escape from the daily drudgery.
DockerGetting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers.
Android AppsBest Free Android Apps. We showcase free Android apps that are definitely worth downloading. There's a strict eligibility criteria for inclusion in this series.
Programming BooksThese best free books accelerate your learning of every programming language. Learn a new language today!
Programming TutorialsThese free tutorials offer the perfect tonic to our free programming books series.
Linux Around The WorldLinux Around The World showcases usergroups that are relevant to Linux enthusiasts. Great ways to meet up with fellow enthusiasts.
Stars and StripesStars and Stripes is an occasional series looking at the impact of Linux in the USA.
Subscribe
Notify of
guest

This site uses Akismet to reduce spam. Please read our Comment FAQ before posting a comment.

0 Comments
Oldest
Newest Most Voted
Inline Feedbacks
View all comments