The plugin adds seven commands, with one also applied on the right-click menu.
There are four types of commands :
Upload
Refresh
Purge
Test
andCheck
Upload
Upload sends the share: true
file and its embedded contents (or note, based on your settings) to the configured repo.
"Shared" meaning here "which have the
share: true
frontmatter key."
It includes:
Upload single current active note
(also in the right-click menu) : Send only the single current active note. The repo can be changed using the frontmatter.Upload all notes
: Send all shared notes to the configured repository.Upload unpublished notes
: Send only the shared note that are not present on the repository.
Refresh
Refresh scans the repository and updates or sends the notes based on some conditions.
Refresh all published notes
: It only updates the content of the published notes. Here, the commit date and the last edited time (from Obsidian) are compared.Refresh published and upload new notes
: It uploads the note not present in the repository and also updates the note edited since the last push. Same as above, dates are compared.
The refresh command use the last edited time and the last commit date to determine if the note has been edited since the last push.
As a dataview table/list/task update don’t edit the contents of a note, it won’t be updated by the refresh command. You can use the
Upload
command to update it.
Purge
There is only one command here : Purge depublished and deleted files
Depublished here means that the
share
key has been removed or set tofalse
.
This command will clean your configured repository by removing the files you deleted or stopped sharing.
Test
Again, only one command : Test the connection to the configured repository
.
It will check if the repository exists, and also the main branch you set. It also checks whether you forgot (or not) to set a value.
Check
The commands is Check the rate limit of the GitHub API
.
It will show you the number of requests you have left, and the time when the limit will be reset.
This commands is also run along the verification of the repository value, and check if you will reach the limit using the commands (upload, refresh and purge), based on the number of files you will send, update or delete.
Note
The rate limit is 5000 requests per hour. If you reach the limit, you will have to wait for the next hour to be able to push again.
Exceding the limit will result in a403
error.
More information about the rate limit can be found here.
Copy path
You can choose to add a command to copy the path (from the blog) of the current note. This command is only available if you have enabled the copy link feature in Plugin.
Run command for a repository
This command is only available if you have more than one repository configured. It will allow you to run a command for a specific repository configured in the settings.
(Others repositories) Reload registered set
For this, there are two commands:
- Reload the opened set (if the file opened is a set)
- Reload all registered set (only if some sets are registered)
It allow to update the frontmatter of the “sets” if you have edited them, without reload the plugin/obsidian or re-register the file.