github/foam
1
1
Fork 0
mirror of https://github.com/foambubble/foam.git synced 2026-01-10 14:38:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

In progress: CLI

Browse Source
This commit is contained in:
Jani Eväkallio
2020-07-04 21:58:58 +01:00
parent 9824a4c6e5
commit b02eefba90
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/cli.md
View File

@@ -1,11 +1,15 @@
# Command Line Interface (stub)
# Command Line Interface
**[[todo]] This [[roadmap]] item needs more specification work.**
Create a CLI tool to allow running common Foam commands. These may include:
If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
- `foam init` - create a new foam workspace
- `foam janitor` - run [[workspace-janitor]] in current workspace
- `foam migrate <tool>` - migrate from tools like roam exports, obsidian and more
More commands to be added.
[//begin]: # "Autogenerated link references for markdown compatibility"
[todo]: todo "Todo"
[roadmap]: roadmap "Roadmap"
[workspace-janitor]: workspace-janitor "Workspace Janitor (stub)"
[//end]: # "Autogenerated link references"

10
docs/roadmap.md
View File

@@ -6,7 +6,7 @@ Some of these items can be achieved by combining existing tools, but others may
Items that are already being worked on. Roadmap items in this stage should have an owner.
- (Empty list)
- [@jevakallio](https://github.com/jevakallio): [[cli]]
## High priority
@@ -20,7 +20,7 @@ If you want to pick up work in this category, you should have a plan on how long
Everything else, categorised into themes. Just because something is on this list doesn't mean it'll get done. If you're interested in working on items in this category, check the [[contribution-guide]] for how to get started.
If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/tree/master/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
**When creating GitHub issues to discuss roadmap items, link them here.**
@@ -75,12 +75,13 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
[//begin]: # "Autogenerated link references for markdown compatibility"
[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
[recipes]: recipes "Recipes"
[workspace-janitor]: workspace-janitor "Workspace Janitor (stub)"
[contribution-guide]: contribution-guide "Contribution Guide"
[improve-default-workspace-settings]: improve-default-workspace-settings "Improve Default Workspace Settings (stub)"
[git-integration]: git-integration "Git integration"
[wiki-links]: wiki-links "Wiki Links"
[foam-file-format]: foam-file-format "Foam File Format"
[workspace-janitor]: workspace-janitor "Workspace Janitor (stub)"
[renaming-files]: renaming-files "Renaming files (stub)"
[unlinked-references]: unlinked-references "Unlinked references (stub)"
[daily-notes]: daily-notes "Daily notes (stub)"
@@ -96,7 +97,7 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
[graph-in-published-workspace]: graph-in-published-workspace "Graph in Published Workspace (stub)"
[linking-between-published-workspaces]: linking-between-published-workspaces "Linking between Published Workspaces (stub)"
[publishing-permissions]: publishing-permissions "Publishing Permissions(stub)"
[cli]: cli "Command Line Interface (stub)"
[cli]: cli "Command Line Interface"
[mobile-apps]: mobile-apps "Mobile Apps (stub)"
[packaged-desktop-app]: packaged-desktop-app "Packaged Desktop App (stub)"
[web-editor]: web-editor "Web Editor (stub)"
@@ -104,5 +105,4 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
[migrating-from-obsidian]: migrating-from-obsidian "Migrating from Obsidian (stub)"
[foam-linter]: foam-linter "Foam Linter (stub)"
[refactoring-via-language-server-protocol]: refactoring-via-language-server-protocol "Refactoring via Language Server Protocol (stub)"
[recipes]: recipes "Recipes"
[//end]: # "Autogenerated link references"