Tikibase Tools

The un-database.

The tikibase tool provides these commands:

• check: verifies the consistency of this Tikibase:
  • broken internal links
  • resources (non-markdown files) that aren't linked to from a markdown file
  • multiple occurrences of the same section in a file
  • inconsistent capitalization of sections
  • documents with empty titles
• find: semantic search
  • find all parsers: tikibase find --is parser
  • find all Markdown parsers: tikibase find --is parser,markdown or tikibase find --is parser --is markdown
• fix: fixes all auto-fixable issues
  • adds occurrences sections containing unmentioned backlinks
• linkify: adds missing links to this Tikibase.
• pitstop: runs all fixes and checks. Run this regularly while making changes to a Tikibase. Use the alias ps to type less.
• stats: shows statistics about this Tikibase
• version: shows the version of the installed tool

configuration

Create a file tikibase.yml in your Tikibase directory to configure this tool. Here is the default configuration:

ignore:
  - node_modules
  - vendor

This supports simple path matching for now, please reach out if you need more sophisticated globbing.

development

• make ps: run after making changes to the code base
• make help: see all available tasks in the Makefile

Install scc to see code statistics via make stats.