111 lines
2.1 KiB
Markdown
111 lines
2.1 KiB
Markdown
# System API
|
|
|
|
The System API provides system-level functions for interacting with the SilverBullet environment.
|
|
|
|
## Function Operations
|
|
|
|
### system.invokeFunction(name, ...)
|
|
Invokes a plug function by name.
|
|
|
|
Example:
|
|
```lua
|
|
-- Invoke a function from a plug
|
|
system.invokeFunction("myplug.processData", "input", 123)
|
|
```
|
|
|
|
## System Information
|
|
|
|
### system.listCommands()
|
|
Lists all available commands.
|
|
|
|
Example:
|
|
```lua
|
|
local commands = system.listCommands()
|
|
for name, def in pairs(commands) do
|
|
print(name .. ": " .. def.description)
|
|
end
|
|
```
|
|
|
|
### system.listSyscalls()
|
|
Lists all available syscalls.
|
|
|
|
Example:
|
|
```lua
|
|
local syscalls = system.listSyscalls()
|
|
for _, syscall in ipairs(syscalls) do
|
|
print(syscall.name)
|
|
end
|
|
```
|
|
|
|
### system.getEnv()
|
|
Returns the runtime environment ("server", "client", or undefined for hybrid).
|
|
|
|
Example:
|
|
```lua
|
|
local env = system.getEnv()
|
|
print("Running in environment: " .. (env or "hybrid"))
|
|
```
|
|
|
|
### system.getMode()
|
|
Returns the current mode of the system ("ro" or "rw").
|
|
|
|
Example:
|
|
```lua
|
|
local mode = system.getMode()
|
|
print("System mode: " .. mode)
|
|
```
|
|
|
|
### system.getVersion()
|
|
Returns the SilverBullet version.
|
|
|
|
Example:
|
|
```lua
|
|
local version = system.getVersion()
|
|
print("SilverBullet version: " .. version)
|
|
```
|
|
|
|
## Configuration
|
|
|
|
### system.getConfig(key, defaultValue?)
|
|
Gets a configuration value.
|
|
|
|
Parameters:
|
|
- `key`: The configuration key to get
|
|
- `defaultValue`: Optional default value if the key is not set
|
|
|
|
Example:
|
|
```lua
|
|
local theme = system.getConfig("theme", "light")
|
|
print("Current theme: " .. theme)
|
|
```
|
|
|
|
### system.reloadConfig()
|
|
Triggers an explicit reload of the configuration.
|
|
|
|
Example:
|
|
```lua
|
|
system.reloadConfig()
|
|
print("Configuration reloaded")
|
|
```
|
|
|
|
### system.reloadPlugs()
|
|
Triggers a reload of all plugs.
|
|
|
|
Example:
|
|
```lua
|
|
system.reloadPlugs()
|
|
print("All plugs reloaded")
|
|
```
|
|
|
|
### system.wipeClient(logout?)
|
|
Completely wipes the client state, including cached files, service worker and databases.
|
|
|
|
Parameters:
|
|
- `logout`: Optional boolean to also log out the user
|
|
|
|
Example:
|
|
```lua
|
|
system.wipeClient(true) -- Wipe client and log out
|
|
print("Client state has been reset")
|
|
```
|