This documentation is intended for fossil extension developers to understand all the commands and to not forget what all commands should do. This documentation should also help find bugs.
Work in progress.
Command | Name | Where | Expected behavior |
---|---|---|---|
fossil.add | Add Files | • Untracked files section entries • Command palette |
1. Execute fossil add $(files) 2. Add files into staged area |
fossil.addAll | Add All Untracked Files | • Untracked files section • Command palette |
Same as fossil.add for all files |
fossil.branch | Create Branch... | • Command palette | 1. Input new branch name 2. Try execute fossil branch new $(branch-name) 3. On error reopen or update branch |
fossil.branchChange | not needed | • Branch name is clicked in status bar | 1. Pick branch name 2. Execute fossil update $(branch-name) |
fossil.cherrypick | Cherry-pick into working directory... | • Main SCM menu • Command palette |
|
fossil.clean | Delete Extras | ||
fossil.clone | Clone Fossil Repository | Source control header | |
fossil.close | Close Repository | Execute fossil close |
|
fossil.closeBranch | Close branch... | 1. Pick a branch 2. Execute fossil tag add --raw closed $(branch-name) |
|
fossil.commit | Commit | ||
fossil.commitAll | Commit All | • Main SCM menu • Command palette |
|
fossil.commitBranch | Commit Creating New Branch... | • Main SCM menu • Command palette |
|
fossil.commitStaged | Commit Staged | • Main SCM menu • Command palette |
|
fossil.commitWithInput | not needed | • Standard commit input box | |
fossil.deleteFile | Delete Untracked File | ||
fossil.deleteFiles | Delete All Untracked Files | ||
fossil.fileLog | Show file history... | ||
fossil.forget | Forget Files | ||
fossil.ignore | Add to ignore-glob | • Command palette • Untracked submenu |
1. Modify /.fossil-settings/ignore-glob 2. Add ignore-glob to the current checkout (not staging)3. Show ignore-glob file |
fossil.init | Initialize Fossil Repository | • Main SCM menu • Command palette |
1. Ask .fossil path2. Ask project name 3. Ask project description 4. Run fossil init 5. Ask to open repository |
fossil.integrate | Integrate into working directory... | ||
fossil.log | Log... | ||
fossil.merge | Merge into working directory... | ||
fossil.open | Open Fossil Repository | ||
fossil.openChange | Open Changes | ||
fossil.openChangeFromUri | Open Changes | • Editor bar | Switch editor to diff mode |
fossil.openFile | Open File | ||
fossil.openFileFromUri | Open File | • Command palette • Editor bar |
When in diff view, there's a special button to show local file |
fossil.openFiles | Open Files | ||
fossil.openResource | not needed | • Source Control panel | Resource in opened in a diff view if possible |
fossil.openUI | Open web UI | • Command palette | execute fossil ui in VSCode terminal |
fossil.patchApply | Apply Patch | • Main SCM menu • Command palette |
1. Select path 2. Execute fossil patch apply $(path) |
fossil.patchCreate | Create Patch | • Main SCM menu • Command palette |
1. Select path 2. Execute fossil patch create $(path) |
fossil.pull | Pull | • Main SCM menu • Command palette |
1. Select remote URI if many 2. Execute fossil pull URI |
fossil.push | Push | • Main SCM menu • Command palette |
1. Execute fossil push |
fossil.pushTo | Push to... | • Main SCM menu • Command palette |
1. Pick remote if > 1 2. Execute fossil push URI |
fossil.redo | Redo | • Main SCM menu • Command palette |
execute fossil redo |
fossil.refresh | Refresh | Source control header | 1. Execute fossil status 2. Update related information |
fossil.render | Preview Using Fossil Renderer | ||
fossil.reopenBranch | Reopen branch... | 1. Pick branch 2. execute fossil tag cancel --raw closed $(branch-name) |
|
fossil.revert | Discard Changes | ||
fossil.revertAll | Discard All Changes | • SCM group header • Command palette |
1. When called from Command palette, revert "conflict" and "changes" groups 2. When called from SCM group header, revert all files in that group. |
fossil.revertChange | Revert Change | • Inline diff window | |
fossil.showOutput | Show fossil output | • Main SCM menu • Command palette |
Reveal outputChannel channel in the UI |
fossil.stage | Stage Changes | ||
fossil.stageAll | Stage All Changes | ||
fossil.stashApply | Stash Apply | • Main SCM menu • Command palette |
|
fossil.stashDrop | Stash Drop | • Main SCM menu • Command palette |
|
fossil.stashPop | Stash Pop | • Main SCM menu • Command palette |
|
fossil.stashSave | Stash Push | • Main SCM menu • Command palette |
|
fossil.stashSnapshot | Stash Snapshot | • Main SCM menu • Command palette |
|
fossil.sync | Sync | • Main SCM menu • Command palette |
execute fossil sync |
fossil.undo | Undo | • Main SCM menu • Command palette |
execute fossil undo |
fossil.unstage | Unstage Changes | ||
fossil.unstageAll | Unstage All Changes | ||
fossil.update | Update | • Main SCM menu • Command palette • Status bar item |
1. Execute fossil update |
fossil.wikiCreate | Publish as Fossil Wiki or Technote |