3.1 KiB
Browser command line
The idea is to transform api methods in command line interface
The default shell command, like:
wacli <tool.dns> <api_methods>
You can also install localy
Binary, if exist
wacli bin <tool.dns>
API
wacli ain <tool.dns>
On your website you will need to use .well-know/wacli.json
file:
{
"api": "<api_url>",
"bin": {
"<platform>": [{
"<architecture>": "<path_for_file"
}]
}
"settings": {
// By default using application json, and it doesn't need to be specified
"contentType": "application/json",
"aliases": [{
"alias": "<short_hand>" | ["short_hand","long_hand"],
"type": "path" | "method" | "bin",
"description": "description of cli command"
"content": "<path>"
}],
"auth": {
"scheme": "basic" | "bearer" | "oauth2"
"tokenName": "<name_of_token>" // - bearer
// oauth2
"flows": {
"implict": {
authorizationUrl: "url",
scopes: {}
}
}
}
}
}
Example as:
{
"api": "https://git.0ut0f.space/swagger.v1.json",
"settings": {
"aliases": [
{
"alias": "issues",
"type": "path",
"content": "/repos/{owner}/{repo}/issues"
},
{
"alias": ["c","create"],
"type": "method",
"content": "POST"
},
{
"alias": "tea",
"type": "bin",
"content": "tea"
}
]
},
"bin": {
"linux": [{"x86": "https://dl.gitea.com/tea/main/tea-main-linux-amd64.xz"}],
"windows": [{"x86": "https://dl.gitea.com/tea/main/tea-main-windows-amd64.xz"}],
"darwin": [
{"arm64": "https://dl.gitea.com/tea/main/tea-main-darwin-arm64"},
{"x86": "https://dl.gitea.com/tea/main/tea-main-darwin-amd64.xz"}
]
}
}
Next REST API - https://git.0ut0f.space/api/v1/repos/{owner}/{repo}/issues
method is transform command:
By default - GET request:
wacli git.0ut0f.space repos issues [owner] [repo]
If you need a request other than GET, then add the command
wacli git.0ut0f.space post|delete|put|path repos issues [owner] [repo]
Such requests may require authorization, so you must log in separately:
wacli auth git.0ut0f.space
tokens are stored separately in the database.
Methods can be overridden:
wacli git.0ut0f.space create repos issues [owner] [repo]
By default, all request in clearnet and tor go via https
, but i2p - http
.
But sometimes you need to specify a specific protocol
wacli bin "git+http://git.0ut0f.space/"
Binaries is install of user directory $HOME/.local/bin
, for root user - /usr/local/bin
.
Perhaps not everyone will add tools to their sites, so for popular tools using directive:
wacli registry:forgejo repos issues
You can also get help on all api methods using the command
wacli help codeberg.org