Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wikibonsai/tendr-cli

Cli tools for markdown-based digital gardening
https://github.com/wikibonsai/tendr-cli

bidirectional-link cli internal-link semantic-tree wikibonsai wikilink wikiref

Last synced: 2 months ago
JSON representation

Cli tools for markdown-based digital gardening

Host: GitHub
URL: https://github.com/wikibonsai/tendr-cli
Owner: wikibonsai
License: gpl-3.0
Created: 2023-03-01T16:52:54.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-04T14:27:13.000Z (4 months ago)
Last Synced: 2024-10-04T15:22:16.813Z (4 months ago)
Topics: bidirectional-link, cli, internal-link, semantic-tree, wikibonsai, wikilink, wikiref
Language: TypeScript
Homepage: https://www.npmjs.com/package/tendr-cli
Size: 652 KB
Stars: 10
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-starred - wikibonsai/tendr-cli - Cli tools for markdown-based digital gardening (cli)

README

# 🪴 tendr-cli 🎍

[![A WikiBonsai Project](https://img.shields.io/badge/%F0%9F%8E%8B-A%20WikiBonsai%20Project-brightgreen)](https://github.com/wikibonsai/wikibonsai)
[![NPM package](https://img.shields.io/npm/v/tendr-cli)](https://npmjs.org/package/tendr-cli)

> ⚠️ 🌱 This project is newly sprouted! So please consider it a beta: Remember to backup all data and please use version control.

CLI tooling to edit [`[[wikirefs]]`](https://github.com/wikibonsai/wikirefs) and [semantic trees](https://github.com/wikibonsai/semtree) in a collection of markdown files. Commands will feel familiar to typical cli commands to inspect files and directories.

🧑‍🌾 🚰 ✂️ Tend your [🎋 WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden with minimalist tooling.

## Install

Install with [npm](https://docs.npmjs.com/cli/v9/commands/npm-install):

```
npm install -g tendr-cli
```

## Use

Example:

```
$ tendr stat
```

Manual:

```
usage: tendr

cli tools for markdown-based digital gardening.

Commands:
tendr lint lint garden files.
tendr tree print full knowledge bonsai.
tendr status show status of file relationships.
[aliases: stat]
tendr rename rename a file and all of its references
. [aliases: rn]
tendr retypedoc rename document type and update all occ
urrences. [aliases: rtdoc, rtd]
tendr retyperef rename reference type and all its occur
rences. [aliases: rtref, rtr]
tendr mkdntowiki [glob] convert from "[markdown](style)" to "[[
wiki-style]]" internal links.
[aliases: mtow]
tendr wikitomkdn [glob] convert from "[[wiki-style]]" to "[mark
down](style)" internal links.
[aliases: wtom]
tendr camltoyaml [glob] convert from "caml" to "yaml" style att
ributes. [aliases: ctoy]
tendr yamltocaml [glob] convert from "yaml" to "caml" style att
ributes. [aliases: ytoc]

Options:
--version Show version number [boolean]
--help Show help [boolean]
```

## Commands

Note:
- Commands expect markdown files using the `.md` extension.
- Commands that perform anything other than read operations will display a confirmation prompt before executing. This may typically be skipped with the force flag (`-f`).

### `lint`

Example:

```
$ tendr lint
```

Sample output:

```
// success

✅ all clean
```

```
// warnings

⚠️ lint warnings:

semtree.lint(): orphan trunk files found:

- i.orphan-trunk-1
- i.orphan-trunk-2
```

```
// errors

❌ lint errors:

semtree.lint(): duplicate entity names found:

- "duplicate-filename"
- File "i.bonsai" Line 1
- File "i.bonsai" Line 4
```

Manual:

```
tendr lint

lint garden files.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-c, --config relative path to config file, including filename; defaults to "
./config.toml" [string] [default: "./config.toml"]
-d, --doctype relative path to doctype file, including filename; defaults to
"t.doc.toml" [string] [default: "./t.doc.toml"]
-r, --root filename for root of tree [string]
-g, --glob glob to index files [string]
```

### `list`, `ls` (⚠️ todo)

List garden information. Runs on all files in current directory and all subdirectories.

Example:

```
$ tendr list
```

Sample output:

todo

Manual:

todo

### `tree`

Example:

```
$ tendr tree
```

Sample output:

```
bk.how-to-read-a-book
├── demanding-reader
| └── active-reading
| ├── reading-comprehension
| └── the-art-of-reading
└── 4-levels-of-reading
├── elementary-reading
├── inspectional-reading
├── analytical-reading
└── syntopical-reading
```

Manual:

```
tendr tree

print full knowledge bonsai/semantic tree

### `status`, `stat`

Example:

```
$ tendr status
```

Sample output:

```
┌────────────────────────────────────┐
│ 📄 RELs for... │
├──────┬─────────┬─────────┬─────────┤
│ FILE │ fname-a │ DOCTYPE │ default │
└──────┴─────────┴─────────┴─────────┘
┌───────────────────────┐
│ 🌳 FAM │
├───────────┬───────────┤
│ ANCESTORS │ i.bonsai │
├───────────┼───────────┤
│ CHILDREN │ • fname-b │
│ │ • fname-c │
│ │ • fname-d │
│ │ • fname-e │
└───────────┴───────────┘
┌─────────────────────────────────────────────────────┐
│ 🕸️ REF │
├───────┬──────────────────────┬──────────────────────┤
│ │ BACK │ FORE │
├───────┼──────────────────────┼──────────────────────┤
│ ATTR │ ◦ attrtype │ ◦ reftype │
│ │ • fname-b │ • fname-b │
│ │ │ ◦ attrtype │
│ │ │ • fname-c │
├───────┼──────────────────────┼──────────────────────┤
│ LINK │ • fname-b (attrtype) │ • fname-d (linktype) │
│ │ • fname-c (linktype) │ • fname-e │
│ │ • fname-d │ • no-doc │
│ │ • i.bonsai │ │
├───────┼──────────────────────┼──────────────────────┤
│ EMBED │ • fname-f │ -- │
└───────┴──────────────────────┴──────────────────────┘
```

Manual:

```
tendr status

show status of file relationships

Options:
--version Show version number [boolean]
--help Show help [boolean]
-k, --kind kind of relationships to list
(kinds: rel, fam, ancestor, child
, ref, attr, link, embed, fore, foreref, foreattr, forelink, fo
reembed, back, backref, backattr, backlink, backembed; default
is "rel") [string] [default: "rel"]
```

### `find` , `f`

Example:

```
$ tendr find
```

Sample output:

Single file:

```
/path/to/notes/fname.md
```

Multiple files:

```
/path/to/notes/fname.md
/path/to/notes/folder/fname.md
```

Manual:

```
tendr find

show full path of markdown file(s) with the given filename.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-r, --regex usage: find ; use regex pattern instead of string -- thi
s will find all filenames containing matches to the regex patte
rn. (use quotes around regex if the terminal is preemptively ex
ecuting it) [boolean] [default: false]
```

### `rename`, `rn`

Example:

```
$ tendr rename
```

Sample Output:

```
$ tendr rename '4-levels-of-reading' 'four-levels-of-reading'
are you sure you want to rename "4-levels-of-reading" to "four-levels-of-reading"? [y/n]
y
UPDATED FILENAMES:
4-levels-of-reading -> four-levels-of-reading
UPDATED FILE CONTENT:
analytical-reading
demanding-reading
elementary-reading
inspectional-reading
syntopical-reading
```

Manual:

```
tendr rename

rename a file and all of its references.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-r, --regex usage: rename ; use regex replacement i
nstead of string replacement -- this will rename all filenames
containing matches to the regex pattern; the regex argument wil
l be replaced by the string argument. (use quotes around regex
if the terminal is preemptively executing it)
[boolean] [default: false]
-f, --force skip verification prompt and perform operation
[boolean] [default: false]
```

### `retyperef`, `rtref`, `rtr`

note: keep in mind this will **not** retype caml primitive properties! this is for wikirefs only.

Example:

```
$ tendr retyperef
```

Manual:

```
tendr retyperef

rename reference type and all its occurrences.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-k, --kind kind of entity to rename (kinds: "reftype", "attrtype", "linkty
pe"; default is "reftype") [string] [default: "reftype"]
```

### `mkdntowiki`, `mtow`

Example:

```
$ tendr mkdntowiki
```

Manual:

```
tendr mkdntowiki [glob]

convert from "[markdown](style)" to "[[wiki-style]]" internal links.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-F, --format how to parse markdown links -- "filename", "relative" urls, or
"absolute" urls [string] [default: "filename"]
-k, --kind kind of references to convert
(kinds: rel, fam, ancestor, child
, ref, attr, link, embed, fore, foreref, foreattr, forelink, fo
reembed, back, backref, backattr, backlink, backembed; default
is "rel") [string] [default: "ref"]
```

### `wikitomkdn`, `wtom`

Example:

```
$ tendr wikitomkdn
```

Manual:

```
tendr wikitomkdn [glob]

convert from "[[wiki-style]]" to "[markdown](style)" internal links.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-F, --format how to format the resulting markdown links -- "filename", "rela
tive" urls, or "absolute" urls [string] [default: "filename"]
-k, --kind kind of references to convert
(kinds: rel, fam, ancestor, child
, ref, attr, link, embed, fore, foreref, foreattr, forelink, fo
reembed, back, backref, backattr, backlink, backembed; default
is "rel") [string] [default: "ref"]
```

### `camltoyaml`, `ctoy`

Example:

```
$ tendr camltoyaml [glob]
```

Manual:

```
tendr camltoyaml [glob]

convert from "caml" to "yaml" style attributes.

Options:
--version Show version number [boolean]
--help Show help [boolean]
```

### `yamltocaml`, `ytoc`

Example:

```
$ tendr yamltocaml [glob]
```

Manual:

```
tendr yamltocaml [glob]

convert from "yaml" to "caml" style attributes.

Options:
--version Show version number [boolean]
--help Show help [boolean]
-f, --format how to format caml output (kinds: "none", "pretty", or "pad
"; default is "none") [string] [default: "pretty"]
-l, --list-format how to format caml output lists (kinds: "mkdn" or "comma";
default is "mkdn") [string] [default: "mkdn"]
-p, --no-prefix do not use colon prefix in caml output
[boolean] [default: true]
```