Knowledge Utils (Knut)

Knut is a knowledge management utilities for managing a second brain. It is based around managing KEGs. For more information see What is Knut.

Apps and Packages

• @jlrickert/knutjs-cli: main CLI for Knut
• @jlrickert/knutjs-core: core Knut library
• @jlrickert/knutjs-tsconfig: shared tsconfig.jsons used throughout the monorepo

Each package and app is 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Useful commands

• pnpm run build - Build all packages and the docs site
• pnpm run dev - Develop all packages and the docs site
• pnpm run lint - Lint all packages
• pnpm run changeset - Generate a changeset
• pnpm run clean - Clean up all node_modules and dist folders (runs each package's clean script)

Versioning and Publishing packages

Package publishing has been configured using Changesets. Please review their documentation to familiarize yourself with the workflow.

This example comes with automated npm releases setup in a GitHub Action. To get this working, you will need to create an NPM_TOKEN and GITHUB_TOKEN in your repository settings. You should also install the Changesets bot on your GitHub repository as well.

For more information about this automation, refer to the official changesets documentation

Contributing

See Contributing guide for more information.

GitHub Package Registry

See Working with the npm registry