@@ -19,7 +19,7 @@ $ npm install -g foam-cli
19
19
$ foam COMMAND
20
20
running command...
21
21
$ foam (-v| --version| version)
22
- foam-cli/0.2 .0 darwin-x64 node-v12.18.0
22
+ foam-cli/0.3 .0 darwin-x64 node-v12.18.0
23
23
$ foam --help [COMMAND]
24
24
USAGE
25
25
$ foam COMMAND
@@ -28,45 +28,63 @@ USAGE
28
28
<!-- usagestop -->
29
29
# Commands
30
30
<!-- commands -->
31
- * [ ` foam hello [FILE] ` ] ( #foam-hello-file )
32
31
* [ ` foam help [COMMAND] ` ] ( #foam-help-command )
32
+ * [ ` foam janitor [WORKSPACEPATH] ` ] ( #foam-janitor-workspacepath )
33
+ * [ ` foam migrate [WORKSPACEPATH] ` ] ( #foam-migrate-workspacepath )
33
34
34
- ## ` foam hello [FILE ] `
35
+ ## ` foam help [COMMAND ] `
35
36
36
- describe the command here
37
+ display help for foam
37
38
38
39
```
39
40
USAGE
40
- $ foam hello [FILE]
41
+ $ foam help [COMMAND]
42
+
43
+ ARGUMENTS
44
+ COMMAND command to show help for
41
45
42
46
OPTIONS
43
- -f, --force
44
- -h, --help show CLI help
45
- -n, --name=name name to print
47
+ --all see all commands in CLI
48
+ ```
49
+
50
+ _ See code: [ @oclif/plugin-help ] ( https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts ) _
51
+
52
+ ## ` foam janitor [WORKSPACEPATH] `
53
+
54
+ Updates link references and heading across all the markdown files in the given workspaces
55
+
56
+ ```
57
+ USAGE
58
+ $ foam janitor [WORKSPACEPATH]
59
+
60
+ OPTIONS
61
+ -h, --help show CLI help
62
+ -w, --without-extensions generate link reference definitions without extensions (for legacy support)
46
63
47
64
EXAMPLE
48
- $ foam hello
49
- hello world from ./src/hello.ts!
65
+ $ foam-cli janitor path-to-foam-workspace
50
66
```
51
67
52
- _ See code: [ src/commands/hello .ts] ( https://github.com/foambubble/foam/blob/v0.2 .0/src/commands/hello .ts ) _
68
+ _ See code: [ src/commands/janitor .ts] ( https://github.com/foambubble/foam/blob/v0.3 .0/src/commands/janitor .ts ) _
53
69
54
- ## ` foam help [COMMAND ] `
70
+ ## ` foam migrate [WORKSPACEPATH ] `
55
71
56
- display help for foam
72
+ Updates file names, link references and heading across all the markdown files in the given workspaces
57
73
58
74
```
59
75
USAGE
60
- $ foam help [COMMAND]
61
-
62
- ARGUMENTS
63
- COMMAND command to show help for
76
+ $ foam migrate [WORKSPACEPATH]
64
77
65
78
OPTIONS
66
- --all see all commands in CLI
79
+ -h, --help show CLI help
80
+ -w, --without-extensions generate link reference definitions without extensions (for legacy support)
81
+
82
+ EXAMPLE
83
+ $ foam-cli migrate path-to-foam-workspace
84
+ Successfully generated link references and heading!
67
85
```
68
86
69
- _ See code: [ @ oclif/plugin-help ] ( https://github.com/oclif/plugin-help /blob/v3.1 .0/src/commands/help .ts ) _
87
+ _ See code: [ src/commands/migrate.ts ] ( https://github.com/foambubble/foam /blob/v0.3 .0/src/commands/migrate .ts ) _
70
88
<!-- commandsstop -->
71
89
72
90
## Development
0 commit comments