Browse the tools
Knowledge
Knowledge is what you want to remember that is not a person or a possession, kept in folders as notes and lists inside a vault.
Tools
List the Knowledge of a vault: its folders in their order, each with the ids and titles of its notes and lists. Read a note with get-knowledge-note and a list with get-knowledge-list.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
Find the notes and lists of a vault's Knowledge holding every word given, in their title, their text, their description or any cell. Case, accents and a typing mistake are ignored.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
querystringrequired - The words to find, at least two letters or digits.
Read one note of a vault's Knowledge: its title, its folder, its text in Markdown as written, and its headings.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
notestringrequired - The id of the note, as list-knowledge gives it.
Read one list of a vault's Knowledge: its title, its description, its columns in order, and its items. Each item holds its texts keyed by the id of their column. A blank cell is left out.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
Add a folder to the Knowledge of a vault, after the folders already there. Folders are not nested. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
namestringrequired - The name of the folder, such as Home or Travel.
Rename a folder of a vault's Knowledge, move it in the order of the folders, or both. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
folderstringrequired - The id of the folder, as list-knowledge gives it.
-
namestringoptional - The new name of the folder.
-
positionintegeroptional - Where the folder goes in the order, 1 for first. A number past the end puts the folder last.
Delete a folder of a vault's Knowledge. Its notes and lists move to the folder given as move_to. Without move_to, they are deleted with the folder, and no tool brings them back. The last folder of a vault cannot be deleted. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
folderstringrequired - The id of the folder to delete, as list-knowledge gives it.
-
move_tostringoptional - The id of another folder of the vault, as list-knowledge gives it, to move the notes and lists of the deleted folder to. Without it, the notes and lists are deleted too.
Write a note in a vault's Knowledge. The text is Markdown: # for a heading, - for a bullet, - [ ] for a task, > for a quote. Without a folder it goes to the first folder, and a vault without any gets "General". A note links to no contact, possession or other note. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
titlestringoptional - The title of the note. "Untitled note" when left out.
-
bodystringoptional - The text of the note, in Markdown.
-
folder_idstringoptional - The id of the folder to write the note in, as list-knowledge gives it.
Change a note of a vault's Knowledge: its title, its text, or the folder it sits in. The text replaces the whole text, so read the note with get-knowledge-note first and send it back changed. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
notestringrequired - The id of the note, as list-knowledge gives it.
-
titlestringoptional - The new title. A blank title keeps the title the note has.
-
bodystringoptional - The whole new text, in Markdown. An empty text clears the text of the note.
-
folder_idstringoptional - The id of the folder to move the note to, as list-knowledge gives it.
Delete a note of a vault's Knowledge for good. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
notestringrequired - The id of the note, as list-knowledge gives it.
Start a list in a vault's Knowledge, with the columns "Name" and "Note". Rename or add columns with update-knowledge-list-column and create-knowledge-list-column, then add items with create-knowledge-list-item. Without a folder it goes to the first folder. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
titlestringoptional - The title of the list. "Untitled list" when left out.
-
descriptionstringoptional - What the list is for, in Markdown.
-
folder_idstringoptional - The id of the folder to put the list in, as list-knowledge gives it.
Change a list of a vault's Knowledge: its title, its description, or the folder it sits in. Its columns and items change through their own tools. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
titlestringoptional - The new title. A blank title keeps the title the list has.
-
descriptionstringoptional - The new description, in Markdown. An empty description clears the description of the list.
-
folder_idstringoptional - The id of the folder to move the list to, as list-knowledge gives it.
Delete a list of a vault's Knowledge for good, with its columns and every item in it. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
Add a column to a list of a vault's Knowledge, after its other columns. Every column holds text. Answers with the whole list. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
namestringrequired - The name of the column, such as City or Rating.
Rename a column of a list of a vault's Knowledge, move it among the columns, or both. Answers with the whole list. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
columnstringrequired - The id of the column, as get-knowledge-list gives it.
-
namestringoptional - The new name of the column.
-
positionintegeroptional - Where the column goes, 1 for first. A number past the end puts the column last.
Remove a column from a list of a vault's Knowledge, with what every item holds in it. No tool brings it back. The last column of a list cannot be removed. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
columnstringrequired - The id of the column, as get-knowledge-list gives it.
Add an item to a list of a vault's Knowledge, after its other items. Its texts are keyed by the id of their column, as get-knowledge-list gives it, and take Markdown. An item with every text blank is refused. Answers with the whole list. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
cellsobjectrequired - The texts of the item, keyed by the id of their column.
Change the texts of an item of a list of a vault's Knowledge. Only the columns given change, and an empty text empties its cell. An item left with every text blank is refused. Answers with the whole list. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
itemstringrequired - The id of the item, as get-knowledge-list gives it.
-
cellsobjectrequired - The texts to change, keyed by the id of their column.
Delete an item of a list of a vault's Knowledge for good, with everything written in it. No tool brings it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
liststringrequired - The id of the list, as list-knowledge gives it.
-
itemstringrequired - The id of the item, as get-knowledge-list gives it.