init-log4brainsdeprecated

Install and configure the Log4brains architecture knowledge base in your project

Usage no npm install needed!

<script type="module">
  import initLog4brains from 'https://cdn.skypack.dev/init-log4brains';
</script>

README

init-log4brains

This interactive CLI lets you install and configure the Log4brains architecture knowledge base in your project.

Usage

You should have a look at the main Log4brains README to get more context.

Start the interactive CLI by running this command in your project root directory:

npx init-log4brains

It will:

  • Install @log4brains/cli and @log4brains/web as development dependencies in your project (it detects automatically whether you use npm or yarn)
  • Add some entries in your package.json's scripts: adr, log4brains-preview, log4brains-build
  • Prompt you some questions in order to create the .log4brains.yml config file for you
  • Import your existing Architecture Decision Records (ADR), or create a first one if you don't have any yet

Documentation