NeboAI
NeboAI
ਸ਼ੁਰੂ ਕਰੋ

plugin.json ਹਵਾਲਾ

plugin.json ਉਹ ਮੈਨੀਫ਼ੈਸਟ ਹੈ ਜਿਸ ਨੂੰ Nebo ਕਿਸੇ ਪਲੱਗਇਨ ਨੂੰ ਇੰਸਟਾਲ ਕਰਨ ਅਤੇ ਚਲਾਉਣ ਲਈ ਪੜ੍ਹਦਾ ਹੈ। ਕੁੰਜੀਆਂ camelCase ਵਿੱਚ ਹੁੰਦੀਆਂ ਹਨ। ਇਹ ਸਫ਼ਾ ਹਰ ਉਸ ਫ਼ੀਲਡ ਦੀ ਸੂਚੀ ਦਿੰਦਾ ਹੈ ਜੋ Nebo ਅੱਜ ਪੜ੍ਹਦਾ ਹੈ ਅਤੇ ਦੱਸਦਾ ਹੈ ਕਿ ਹਰ ਇੱਕ ਕੀ ਕਰਦੀ ਹੈ।

ਉੱਪਰਲੇ ਪੱਧਰ ਦੀਆਂ ਫ਼ੀਲਡਾਂ

ਫ਼ੀਲਡਕਿਸਮਲਾਜ਼ਮੀਅਰਥ
idstringਹਾਂਪਲੱਗਇਨ ਦਾ ਮਾਰਕੀਟਪਲੇਸ ਪਛਾਣਕਰਤਾ। ਵਿਕਾਸ ਦੌਰਾਨ slug ਵਰਤੋ।
slugstringਹਾਂਸਥਿਰ ਪਛਾਣਕਰਤਾ। [a-z0-9-], ਵੱਧ ਤੋਂ ਵੱਧ 64 ਅੱਖਰ, ਸ਼ੁਰੂ ਜਾਂ ਅੰਤ ਵਿੱਚ ਹਾਈਫ਼ਨ ਨਹੀਂ ਅਤੇ ਦੋਹਰਾ ਹਾਈਫ਼ਨ ਨਹੀਂ। ਇਹ plugin__<slug> ਟੂਲ ਅਤੇ <SLUG>_BIN ਵੇਰੀਏਬਲ ਦਾ ਨਾਮ ਬਣਦਾ ਹੈ।
namestringਹਾਂਦਿਖਾਇਆ ਜਾਣ ਵਾਲਾ ਨਾਮ। ਉਸ ਸੇਵਾ ਦਾ ਨਾਮ ਦਿਓ ਜਿਸ ਨਾਲ ਇਹ ਜੁੜਦਾ ਹੈ।
versionstringਹਾਂਸਿਮੈਂਟਿਕ ਵਰਜਨ, ਜਿਵੇਂ 0.1.0।
platformsmapਹਾਂਪਲੇਟਫ਼ਾਰਮ ਕੁੰਜੀ ਤੋਂ ਬਾਈਨਰੀ। Platforms ਦੇਖੋ।
descriptionstringਨਹੀਂਲੋਕਾਂ ਅਤੇ ਕਰਮਚਾਰੀਆਂ ਲਈ ਇੱਕ ਵਾਕ।
authorstringਨਹੀਂਪ੍ਰਕਾਸ਼ਕ ਦਾ ਨਾਮ।
categorystringਨਹੀਂਕਰਮਚਾਰੀਆਂ ਨੂੰ ਪਲੱਗਇਨ ਲੱਭਣ ਵਿੱਚ ਮਦਦ ਕਰਦਾ ਹੈ।
triggersਸਟ੍ਰਿੰਗਾਂ ਦੀ ਸੂਚੀਨਹੀਂਸ਼ਬਦ ਜੋ ਦੱਸਦੇ ਹਨ ਕਿ ਪਲੱਗਇਨ ਕਦੋਂ ਲਾਗੂ ਹੁੰਦਾ ਹੈ। ਖੋਜ ਸੰਕੇਤਾਂ ਵਿੱਚ ਵਰਤੇ ਜਾਂਦੇ ਹਨ।
entrySkillsਸਟ੍ਰਿੰਗਾਂ ਦੀ ਸੂਚੀਨਹੀਂਬੰਡਲ ਕੀਤੇ ਸਕਿੱਲ ਜਿਹਨਾਂ ਦਾ ਨਾਮ ਪਲੱਗਇਨ ਦੇ ਟੂਲ ਵੇਰਵੇ ਵਿੱਚ ਸਭ ਤੋਂ ਪਹਿਲਾਂ ਲੈਣਾ ਹੈ।
dependencies{name, version, optional} ਦੀ ਸੂਚੀਨਹੀਂਹੋਰ ਪਲੱਗਇਨ ਜੋ ਇਹ ਪਲੱਗਇਨ ਚਲਾਉਂਦਾ ਹੈ। version ਦਾ ਡਿਫ਼ੌਲਟ "*" ਹੈ; optional ਦਾ false। ਉਹਨਾਂ ਦੇ <SLUG>_BIN ਪਾਥ ਹਰ ਕਾਲ ’ਤੇ ਸੈੱਟ ਕੀਤੇ ਜਾਂਦੇ ਹਨ।
authobjectਨਹੀਂਸਾਈਨ-ਇਨ ਅਤੇ ਖਾਤੇ। Auth ਦੇਖੋ।
capabilitiesobjectਨਹੀਂconfigSchema, hooks, commands, routes, providers.
permissionsobjectਨਹੀਂਵਾਤਾਵਰਣ ਫ਼ਿਲਟਰਿੰਗ ਅਤੇ ਟਾਈਮਆਊਟ ਦੀ ਉੱਪਰਲੀ ਹੱਦ।
eventslistਨਹੀਂਨਿਗਰਾਨ ਜੋ ਕਰਮਚਾਰੀਆਂ ਦੇ ਵਰਕਫਲੋ ਨੂੰ ਡਾਟਾ ਦਿੰਦੇ ਹਨ।
interfaceBindingsmapਨਹੀਂਪਲੱਗਇਨ ਵੱਲੋਂ ਦਿੱਤੇ ਜਾਂਦੇ ਟਾਈਪ ਕੀਤੇ ਓਪਰੇਸ਼ਨ।
channelobjectਨਹੀਂਕਿਸੇ ਮੈਸੇਜਿੰਗ ਸੇਵਾ ਨਾਲ ਸਥਾਈ ਪੁਲ।
setupobjectਨਹੀਂਕਦਮ-ਦਰ-ਕਦਮ ਸੈੱਟਅੱਪ ਵਿਜ਼ਾਰਡ।

Nebo ਮਾਰਕੀਟਪਲੇਸ ਤੋਂ ਹੋਣ ਵਾਲੇ ਇੰਸਟਾਲਾਂ ਦੀ ਜਾਂਚ ਕਰਦਾ ਹੈ: slug ਦੇ ਨਿਯਮ, ਇੱਕ ਸਿਮੈਂਟਿਕ ਵਰਜਨ, ਘੱਟੋ-ਘੱਟ ਇੱਕ ਪਲੇਟਫ਼ਾਰਮ, ਪਾਥ ਵੱਖਰੇਵੇਂ ਜਾਂ .. ਤੋਂ ਬਿਨਾਂ binaryName, ਇੱਕ login ਕਮਾਂਡ ਜਦੋਂ ਤੱਕ auth.type env ਨਹੀਂ ਹੈ, ਖ਼ਾਲੀ ਨਾ ਹੋਣ ਵਾਲੇ ਇਵੈਂਟ ਨਾਮ ਅਤੇ ਕਮਾਂਡਾਂ, ਅਤੇ ਬਾਈਂਡਿੰਗ ਟੈਮਪਲੇਟ ਜੋ ਠੀਕ ਪਾਰਸ ਹੁੰਦੇ ਹੋਣ। ਯੂਜ਼ਰ ਪਲੱਗਇਨ ਡਾਇਰੈਕਟਰੀ ਵਿਚਲੇ ਪਲੱਗਇਨ ਜਾਂਚ ਤੋਂ ਛੋਟ ਪਾਉਂਦੇ ਹਨ।

ਪਲੇਟਫ਼ਾਰਮ

ਕੁੰਜੀਆਂ darwin-arm64, darwin-amd64, linux-arm64, linux-amd64, windows-arm64 ਅਤੇ windows-amd64 ਹਨ। ਹਰ ਐਂਟਰੀ ਵਿੱਚ ਹੇਠਲੀਆਂ ਸਾਰੀਆਂ ਪੰਜ ਫ਼ੀਲਡਾਂ ਹੁੰਦੀਆਂ ਹਨ। ਜਦੋਂ ਤੁਸੀਂ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰਦੇ ਹੋ, ਮਾਰਕੀਟਪਲੇਸ ਅਸਲ ਹੈਸ਼, ਆਕਾਰ, ਦਸਤਖ਼ਤ ਅਤੇ ਡਾਊਨਲੋਡ URL ਲਿਖ ਦਿੰਦਾ ਹੈ, ਇਸ ਲਈ ਅੱਪਲੋਡ ਕੀਤੀ ਜਾਣ ਵਾਲੀ ਫ਼ਾਈਲ ਵਿੱਚ ਇਹਨਾਂ ਨੂੰ ਖ਼ਾਲੀ ਛੱਡੋ।

"platforms": {
  "darwin-arm64":  { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "linux-amd64":   { "binaryName": "notes-sync",     "sha256": "", "signature": "", "size": 0, "downloadUrl": "" },
  "windows-amd64": { "binaryName": "notes-sync.exe", "sha256": "", "signature": "", "size": 0, "downloadUrl": "" }
}
ਫ਼ੀਲਡਅਰਥ
binaryNameਐਗਜ਼ੀਕਿਊਟੇਬਲ ਦਾ ਫ਼ਾਈਲ ਨਾਮ। Windows ’ਤੇ .exe ਜੋੜੋ।
sha256ਬਾਈਨਰੀ ਦਾ ਹੈਸ਼। ਇੰਸਟਾਲ ਵੇਲੇ ਜਾਂਚਿਆ ਜਾਂਦਾ ਹੈ।
signatureਬਾਈਨਰੀ ਦੇ ਦਸਤਖ਼ਤ। ਸਾਈਨਿੰਗ ਕੁੰਜੀ ਉਪਲਬਧ ਹੋਣ ’ਤੇ ਇੰਸਟਾਲ ਵੇਲੇ ਜਾਂਚੇ ਜਾਂਦੇ ਹਨ।
sizeਬਾਈਟਾਂ ਵਿੱਚ ਆਕਾਰ।
downloadUrlਜਿੱਥੋਂ Nebo ਪੈਕੇਜ ਡਾਊਨਲੋਡ ਕਰਦਾ ਹੈ।

Auth

ਫ਼ੀਲਡਅਰਥ
typeਪਲੱਗਇਨ ਵੱਲੋਂ ਚਲਾਏ ਬ੍ਰਾਊਜ਼ਰ ਸਾਈਨ-ਇਨ ਲਈ oauth_cli; ਮੁੱਲਾਂ ਵਜੋਂ ਭਰੇ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲਾਂ ਲਈ env; ਮਾਲਕ ਦਾ NeboAI ਟੋਕਨ _TOKEN ਨਾਲ ਖ਼ਤਮ ਹੋਣ ਵਾਲੀ ਹਰ auth.env ਕੁੰਜੀ ਵਿੱਚ ਲੈਣ ਲਈ neboai।
envਵੇਰੀਏਬਲ ਨਾਮ ਤੋਂ ਡਿਫ਼ੌਲਟ ਮੁੱਲ ਦਾ ਨਕਸ਼ਾ। ਇਹੀ ਉਹ ਇੱਕੋ-ਇੱਕ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲ ਨਾਮ ਹਨ ਜੋ Nebo login ਨੂੰ ਦਿੰਦਾ ਹੈ।
commands.loginਸਾਈਨ ਇਨ ਕਰਦਾ ਹੈ। ਲਾਜ਼ਮੀ ਹੈ ਜਦੋਂ ਤੱਕ type env ਨਹੀਂ ਹੈ। ਖਾਤਾ ਫੋਲਡਰ ਸੈੱਟ ਕਰਕੇ ਚੱਲਦਾ ਹੈ।
commands.statusJSON ਪ੍ਰਿੰਟ ਕਰਦਾ ਹੈ ਜੋ ਦੱਸਦਾ ਹੈ ਕਿ ਖਾਤਾ ਸਾਈਨ ਇਨ ਹੈ ਜਾਂ ਨਹੀਂ।
commands.refreshਬਿਨਾਂ ਕਿਸੇ ਦਖ਼ਲ ਦੇ ਟੋਕਨ ਨਵਿਆਉਂਦਾ ਹੈ।
commands.logoutਸਾਈਨ ਆਊਟ ਕਰਦਾ ਹੈ। ਸਿਰਫ਼ ਮਾਲਕ ਇਸ ਨੂੰ ਚਲਾ ਸਕਦਾ ਹੈ।
profileDirEnvਵੇਰੀਏਬਲ ਜਿਸ ਨੂੰ ਹਰ ਕਰਮਚਾਰੀ ਅਤੇ ਖਾਤੇ ਲਈ ਵੱਖਰਾ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲ ਫੋਲਡਰ ਮਿਲਦਾ ਹੈ। ਇਸ ਤੋਂ ਬਿਨਾਂ ਪਲੱਗਇਨ ਇੱਕ ਸਾਂਝਾ ਖਾਤਾ ਰੱਖਦਾ ਹੈ।
label, descriptionਕਨੈਕਟ ਕਾਰਡ ’ਤੇ ਲਿਖਤ।
helpਕਨੈਕਟ ਕਰਦੇ ਸਮੇਂ ਦਿਖਾਇਆ ਜਾਂਦਾ {url, urlLabel, text}।
publicRedirectਜਦੋਂ ਪ੍ਰੋਵਾਈਡਰ http://localhost ਰੀਡਾਇਰੈਕਟ ਨਾ ਮੰਨੇ ਤਾਂ true ਸੈੱਟ ਕਰੋ; ਫਿਰ ਸਾਈਨ-ਇਨ NeboAI ਦੇ ਜਨਤਕ ਰੀਡਾਇਰੈਕਟ ਰਾਹੀਂ ਹੁੰਦਾ ਹੈ।

Nebo ਸਥਿਤੀ ਆਉਟਪੁਟ ਵਿੱਚ authenticated, isAuthenticated, logged_in, loggedIn ਜਾਂ token_valid ਵਿੱਚੋਂ ਪਹਿਲਾ ਮਿਲਣ ਵਾਲਾ ਪੜ੍ਹਦਾ ਹੈ। ਖ਼ਾਲੀ ਨਾ ਹੋਣ ਵਾਲਾ token_error, ਜਾਂ credential_source, auth_method, storage ਜਾਂ status ਵਿੱਚ none ਮੁੱਲ ਦਾ ਅਰਥ ਹੈ ਸਾਈਨ ਆਊਟ। ਸਥਿਤੀ ਕਮਾਂਡ ਕੋਲ 45 ਸਕਿੰਟ ਹੁੰਦੇ ਹਨ।

{"authenticated": true, "account": "finance@example.com"}

configSchema

capabilities.configSchema ਉਹਨਾਂ ਮੁੱਲਾਂ ਦਾ ਵੇਰਵਾ ਦਿੰਦਾ ਹੈ ਜੋ ਮਾਲਕ ਪਲੱਗਇਨ ਲਈ ਸੈੱਟ ਕਰਦਾ ਹੈ। ਹਰ ਮੁੱਲ ਬਾਈਨਰੀ ਤੱਕ key ਨਾਮ ਵਾਲੇ ਵਾਤਾਵਰਣ ਵੇਰੀਏਬਲ ਵਜੋਂ ਪਹੁੰਚਦਾ ਹੈ। ਜੋ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲ ਕੁੰਜੀਆਂ auth.env ਵਿੱਚ ਵੀ ਦਰਜ ਹਨ, ਉਹਨਾਂ ਲਈ ਸਕੀਮਾ ਹਰ ਕਰਮਚਾਰੀ ਦੇ ਕਨੈਕਟ ਫ਼ਾਰਮ ਦੀਆਂ ਫ਼ੀਲਡਾਂ ਦੇ ਲੇਬਲ ਦਿੰਦਾ ਹੈ।

ਫ਼ੀਲਡਕਿਸਮਡਿਫ਼ੌਲਟਅਰਥ
keystringਲਾਜ਼ਮੀਵਾਤਾਵਰਣ ਵੇਰੀਏਬਲ ਦਾ ਨਾਮ।
labelstringਲਾਜ਼ਮੀਫ਼ੀਲਡ ਦਾ ਲੇਬਲ।
descriptionstring""ਮਦਦ ਲਿਖਤ।
fieldTypestring"string"ਇਨਪੁਟ ਦੀ ਕਿਸਮ, ਜਿਵੇਂ string, number, boolean, select ਜਾਂ password।
defaultstringਕੋਈ ਨਹੀਂਪਹਿਲਾਂ ਤੋਂ ਭਰਿਆ ਮੁੱਲ।
requiredbooleanfalseਜਦੋਂ ਤੱਕ ਮੁੱਲ ਸੈੱਟ ਨਹੀਂ ਹੁੰਦਾ, ਪਲੱਗਇਨ ਤਿਆਰ ਨਹੀਂ ਹੁੰਦਾ।
secretbooleanfalseਵਾਪਸ ਪੜ੍ਹਨ ’ਤੇ ਮੁੱਲ ਲੁਕਾਇਆ ਜਾਂਦਾ ਹੈ।
optionsਸਟ੍ਰਿੰਗਾਂ ਦੀ ਸੂਚੀਕੋਈ ਨਹੀਂselect ਲਈ ਵਿਕਲਪ।

permissions

ਫ਼ੀਲਡਡਿਫ਼ੌਲਟਅਰਥ
envAllow[]ਵਿਰਾਸਤ ਵਿੱਚ ਮਿਲੇ ਵੇਰੀਏਬਲ ਜੋ ਪਲੱਗਇਨ ਦੇਖ ਸਕਦਾ ਹੈ। ਖ਼ਾਲੀ ਹੋਵੇ ਤਾਂ ਸਭ ਦੀ ਇਜਾਜ਼ਤ ਹੈ।
envDeny[]ਵਿਰਾਸਤ ਵਿੱਚ ਮਿਲੇ ਵੇਰੀਏਬਲ ਜੋ ਹਮੇਸ਼ਾ ਹਟਾਏ ਜਾਂਦੇ ਹਨ।
maxTimeoutSeconds300ਕਿਸੇ ਵੀ ਕਾਲ ਦੇ ਟਾਈਮਆਊਟ ਦੀ ਉੱਪਰਲੀ ਹੱਦ।
networkfalseਨੈੱਟਵਰਕ ਦੀ ਵਰਤੋਂ ਦਾ ਐਲਾਨ ਕਰਦਾ ਹੈ। ਸਿਰਫ਼ ਜਾਣਕਾਰੀ ਲਈ; ਲਾਗੂ ਨਹੀਂ ਕੀਤਾ ਜਾਂਦਾ।

events

ਇਵੈਂਟ ਇੱਕ ਲੰਮੇ ਸਮੇਂ ਤੱਕ ਚੱਲਣ ਵਾਲਾ ਨਿਗਰਾਨ ਹੈ। ਜਦੋਂ ਕਿਸੇ ਕਰਮਚਾਰੀ ਦਾ ਵਰਕਫਲੋ ਇਸ ’ਤੇ ਨਜ਼ਰ ਰੱਖਦਾ ਹੈ ਤਾਂ Nebo ਇਸ ਨੂੰ ਚਾਲੂ ਕਰਦਾ ਹੈ, ਅਤੇ ਬੰਦ ਹੋ ਜਾਣ ’ਤੇ ਮੁੜ ਚਾਲੂ ਕਰਦਾ ਹੈ। ਨਿਗਰਾਨ ਵੱਲੋਂ stdout ’ਤੇ ਲਿਖੀ ਹਰ ਲਾਈਨ ਇੱਕ ਇਵੈਂਟ ਹੈ। ਚੱਲਣ ਵੇਲੇ ਇਵੈਂਟ ਦੇ ਨਾਮ ਅੱਗੇ slug ਲਗਾਇਆ ਜਾਂਦਾ ਹੈ, ਇਸ ਲਈ note.created ਬਣ ਜਾਂਦਾ ਹੈ notes-sync.note.created।

"events": [
  {
    "name": "note.created",
    "description": "A note was created in the watched notebook.",
    "command": "watch --notebook {{notebook}} --format ndjson"
  }
]
ਫ਼ੀਲਡਅਰਥ
nameslug ਤੋਂ ਬਿਨਾਂ ਇਵੈਂਟ ਦਾ ਨਾਮ। ਲਾਜ਼ਮੀ।
commandਨਿਗਰਾਨ ਨੂੰ ਚਾਲੂ ਕਰਨ ਵਾਲੇ ਆਰਗੂਮੈਂਟ। ਲਾਜ਼ਮੀ। {{key}} ਕਰਮਚਾਰੀ ਦੇ ਇਨਪੁਟ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲਿਆ ਜਾਂਦਾ ਹੈ।
descriptionਇਵੈਂਟ ਦਾ ਕਾਰਨ ਕੀ ਬਣਦਾ ਹੈ।
multiplexedtrue ਹੋਣ ’ਤੇ ਇੱਕ ਨਿਗਰਾਨ ਕਈ ਕਿਸਮਾਂ ਦੇ ਇਵੈਂਟ ਭੇਜਦਾ ਹੈ ਅਤੇ ਹਰ ਲਾਈਨ ਵਿੱਚ ਇੱਕ "event" ਫ਼ੀਲਡ ਹੁੰਦੀ ਹੈ।

ਵਰਕਫਲੋ watch ਟ੍ਰਿਗਰ ਨਾਲ ਇਵੈਂਟਾਂ ਦੀ ਗਾਹਕੀ ਲੈਂਦੇ ਹਨ। ਟ੍ਰਿਗਰ ਦੇਖੋ।

interfaceBindings

ਬਾਈਂਡਿੰਗ ਇੱਕ ਇੰਟਰਫ਼ੇਸ ਓਪਰੇਸ਼ਨ ਨੂੰ ਤੁਹਾਡੀ ਕਿਸੇ ਕਮਾਂਡ ਨਾਲ ਜੋੜਦੀ ਹੈ। ਹਰ ਬਾਈਂਡਿੰਗ ਕਰਮਚਾਰੀਆਂ ਲਈ ਇੱਕ ਟਾਈਪ ਕੀਤਾ ਟੂਲ ਬਣ ਜਾਂਦੀ ਹੈ, ਜਿਸ ਦਾ ਨਾਮ ਓਪਰੇਸ਼ਨ ਦੇ ਨਾਮ ਉੱਤੇ ਛੋਟੇ ਅੱਖਰਾਂ ਵਿੱਚ ਹੁੰਦਾ ਹੈ ਅਤੇ ਬਿੰਦੂਆਂ ਤੇ ਹਾਈਫ਼ਨਾਂ ਦੀ ਥਾਂ ਅੰਡਰਸਕੋਰ ਹੁੰਦੇ ਹਨ: notes.search ਬਣ ਜਾਂਦਾ ਹੈ notes_search। ਬਾਈਂਡਿੰਗਾਂ ਰਾਹੀਂ ਹੀ ਪਲੱਗਇਨ ਉਹ ਸਮਰੱਥਾਵਾਂ ਪੂਰੀਆਂ ਕਰਦਾ ਹੈ ਜਿਹਨਾਂ ਦੀ ਕਰਮਚਾਰੀ ਨੂੰ ਲੋੜ ਹੁੰਦੀ ਹੈ; ਸਮਰੱਥਾਵਾਂ ਦੇਖੋ।

"interfaceBindings": {
  "notes.search": "notes search --query {query} {tag[]:--tag} {limit?:--limit}",
  "invoice.create": "invoices create --amount {amount_cents:cents->dollars}"
}
ਪਲੇਸਹੋਲਡਰਇਸ ਵਿੱਚ ਬਦਲਦਾ ਹੈ
{field}ਫ਼ੀਲਡ ਦਾ ਮੁੱਲ ਇੱਕ ਸ਼ਬਦ ਵਜੋਂ। ਫ਼ੀਲਡ ਨੂੰ ਫ਼ਲੈਗ ਵਜੋਂ ਵੱਖਰਾ ਨਹੀਂ ਭੇਜਿਆ ਜਾਂਦਾ।
{field[]:--flag}ਸੂਚੀ ਫ਼ੀਲਡ ਦੀ ਹਰ ਆਈਟਮ ਲਈ ਇੱਕ --flag <item> ਜੋੜਾ।
{field?:--flag}ਫ਼ੀਲਡ ਮੌਜੂਦ ਹੋਣ ’ਤੇ --flag <value>; ਗ਼ੈਰ-ਮੌਜੂਦ ਹੋਣ ’ਤੇ ਕੁਝ ਨਹੀਂ।
{field:cents->dollars}ਸੈਂਟਾਂ ਵਿੱਚ ਇੱਕ ਪੂਰਨ ਅੰਕ ਰਕਮ, ਡਾਲਰਾਂ ਵਜੋਂ ਲਿਖੀ।

ਜਿਹਨਾਂ ਇਨਪੁਟ ਫ਼ੀਲਡਾਂ ਦਾ ਟੈਮਪਲੇਟ ਵਿੱਚ ਨਾਮ ਨਹੀਂ, ਉਹ --field value ਵਜੋਂ ਅੰਤ ਵਿੱਚ ਜੋੜੀਆਂ ਜਾਂਦੀਆਂ ਹਨ। ਸੂਚੀ ਅਤੇ ਵਿਕਲਪਿਕ ਪਲੇਸਹੋਲਡਰ ਪੂਰੇ ਸ਼ਬਦ ਹੋਣੇ ਚਾਹੀਦੇ ਹਨ। ਜਿਸ ਓਪਰੇਸ਼ਨ ਲਈ ਮਨਜ਼ੂਰੀ ਲੋੜੀਂਦੀ ਹੈ, ਉਸ ਤੱਕ plugin__<slug> ਰਾਹੀਂ ਉਹੀ ਕਮਾਂਡ ਕਾਲ ਕਰਕੇ ਨਹੀਂ ਪਹੁੰਚਿਆ ਜਾ ਸਕਦਾ।

ਹੁੱਕ, ਸਲੈਸ਼ ਕਮਾਂਡਾਂ ਅਤੇ ਰੂਟ

"capabilities": {
  "hooks": [
    { "hook": "tool.post_execute", "hookType": "filter", "command": "hook redact", "priority": 50, "timeoutMs": 500 }
  ],
  "commands": [
    { "name": "notes", "description": "Show today's notes", "command": "notes today", "slash": true }
  ],
  "routes": [
    { "path": "/callback", "method": "GET", "command": "http callback" }
  ]
}

hooks

ਹੁੱਕ ਕਰਮਚਾਰੀ ਦੀ ਵਾਰੀ ਦੇ ਕਿਸੇ ਬਿੰਦੂ ’ਤੇ ਤੁਹਾਡੀ ਕਮਾਂਡ ਚਲਾਉਂਦਾ ਹੈ। Nebo stdin ’ਤੇ ਇੱਕ JSON ਪੇਲੋਡ ਲਿਖਦਾ ਹੈ। action ਹੁੱਕ ਦੇ ਆਉਟਪੁੱਟ ਨੂੰ ਅਣਡਿੱਠਾ ਕੀਤਾ ਜਾਂਦਾ ਹੈ। filter ਹੁੱਕ {"payload": ..., "handled": false} ਵਾਪਸ ਕਰਦਾ ਹੈ; "handled": true ਬਾਅਦ ਵਾਲੇ ਹੁੱਕਾਂ ਨੂੰ ਰੋਕ ਦਿੰਦਾ ਹੈ। ਗਲਤੀਆਂ ਅਤੇ ਟਾਈਮਆਊਟ ਹੋਣ ’ਤੇ ਪਿਛਲਾ ਪੇਲੋਡ ਬਣਿਆ ਰਹਿੰਦਾ ਹੈ ਅਤੇ ਵਾਰੀ ਕਦੇ ਨਹੀਂ ਰੁਕਦੀ। ਲਗਾਤਾਰ ਤਿੰਨ ਵਾਰ ਅਸਫਲ ਹੋਣ ਤੋਂ ਬਾਅਦ ਹੁੱਕ ਨੂੰ ਪੰਜ ਮਿੰਟ ਲਈ ਰੋਕ ਦਿੱਤਾ ਜਾਂਦਾ ਹੈ।

ਫ਼ੀਲਡਡਿਫ਼ੌਲਟਅਰਥ
hookਲਾਜ਼ਮੀtool.pre_execute, tool.post_execute, message.post_receive, session.message_append, steering.generate, agent.turn, agent.should_continue ਵਿੱਚੋਂ ਇੱਕ।
hookType"action"action ਜਾਂ filter।
commandਲਾਜ਼ਮੀਤੁਹਾਡੀ ਬਾਈਨਰੀ ਲਈ ਆਰਗੂਮੈਂਟ।
priority100ਘੱਟ ਵਾਲਾ ਪਹਿਲਾਂ ਚੱਲਦਾ ਹੈ।
timeoutMs500ਮਿਲੀਸਕਿੰਟਾਂ ਵਿੱਚ ਸਮਾਂ ਸੀਮਾ।

commands

"slash": true ਨਾਲ, ਚੈਟ ਵਿੱਚ /name args ਲਿਖਣ ’ਤੇ ਕਰਮਚਾਰੀ ਤੋਂ ਬਿਨਾਂ ਸਿੱਧਾ command args ਚੱਲਦਾ ਹੈ। ਆਉਟਪੁਟ ਹੀ ਜਵਾਬ ਹੁੰਦਾ ਹੈ। ਸਮਾਂ ਸੀਮਾ 30 ਸਕਿੰਟ ਹੈ।

routes

ਰੂਟ ਬੋਟ ’ਤੇ /api/v1/plugins/<slug>/api/<path> ਉੱਤੇ HTTP ਬੇਨਤੀਆਂ ਦਾ ਜਵਾਬ ਦਿੰਦਾ ਹੈ, path ਅਤੇ method ਨਾਲ ਮੇਲ ਕਰਕੇ। ਬੇਨਤੀ ਦੀ ਬਾਡੀ stdin ’ਤੇ ਜਾਂਦੀ ਹੈ ਅਤੇ ਤੁਹਾਡਾ stdout ਜਵਾਬ ਹੁੰਦਾ ਹੈ। ਸਮਾਂ ਸੀਮਾ 30 ਸਕਿੰਟ ਹੈ।

providers

ਪ੍ਰੋਵਾਈਡਰ ਇੱਕ ਚੈਟ ਮਾਡਲ ਸਰੋਤ ਜੋੜਦਾ ਹੈ। id, displayName, providerType, modelsCommand ਅਤੇ chatCommand ਦਾ ਐਲਾਨ ਕਰੋ। Nebo ਚੈਟ ਬੇਨਤੀ JSON ਵਜੋਂ stdin ਰਾਹੀਂ chatCommand ਨੂੰ ਭੇਜਦਾ ਹੈ ਅਤੇ stdout ਤੋਂ ਨਵੀਂ-ਲਾਈਨ ਨਾਲ ਵੱਖ ਕੀਤੇ JSON ਵਜੋਂ ਸਟ੍ਰੀਮ ਕੀਤੇ ਇਵੈਂਟ 300 ਸਕਿੰਟਾਂ ਤੱਕ ਪੜ੍ਹਦਾ ਹੈ। ਅੱਜ ਸਿਰਫ਼ ਚੈਟ ਸਟ੍ਰੀਮਿੰਗ ਵਰਤੀ ਜਾਂਦੀ ਹੈ।

channel

ਚੈਨਲ ਕਿਸੇ ਮੈਸੇਜਿੰਗ ਸੇਵਾ ਨਾਲ ਪੁਲ ਬਣਾਉਂਦਾ ਹੈ। Nebo command ਨੂੰ ਚੱਲਦਾ ਰੱਖਦਾ ਹੈ, ਇਸ ਦੇ stdout ਤੋਂ ਆਉਣ ਵਾਲੇ ਸੁਨੇਹੇ ਪੜ੍ਹਦਾ ਹੈ ਅਤੇ ਇਸ ਦੇ stdin ’ਤੇ ਜਵਾਬ ਲਿਖਦਾ ਹੈ, ਦੋਵੇਂ ਨਵੀਂ-ਲਾਈਨ ਨਾਲ ਵੱਖ ਕੀਤੇ JSON ਵਜੋਂ।

ਫ਼ੀਲਡਡਿਫ਼ੌਲਟਅਰਥ
commandਲਾਜ਼ਮੀਪੁਲ ਨੂੰ ਚਾਲੂ ਕਰਨ ਵਾਲੇ ਆਰਗੂਮੈਂਟ।
name, description""ਸੈਟਿੰਗਾਂ ਵਿੱਚ ਦਿਖਾਇਆ ਜਾਂਦਾ ਹੈ।
restartDelaySecs5ਕ੍ਰੈਸ਼ ਤੋਂ ਬਾਅਦ ਮੁੜ ਚਾਲੂ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਉਡੀਕ।
sharedfalseਸਾਰੇ ਕਰਮਚਾਰੀਆਂ ਲਈ ਇੱਕ ਪੁਲ; ਸੁਨੇਹੇ ਕਰਮਚਾਰੀ ਦੇ ਨਾਮ ਅਨੁਸਾਰ ਭੇਜੇ ਜਾਂਦੇ ਹਨ ਅਤੇ ਜਵਾਬਾਂ ਵਿੱਚ ਹਰ ਕਰਮਚਾਰੀ ਦੀ ਪਛਾਣ ਹੁੰਦੀ ਹੈ।
needsLocalApifalseਪੁਲ ਨੂੰ ਬੋਟ ਦਾ ਲੋਕਲ API ਪਤਾ, ਇੱਕ ਟੋਕਨ ਅਤੇ ਕਰਮਚਾਰੀ id ਦਿਓ। ਜਦੋਂ ਤੱਕ ਲੋੜ ਨਾ ਹੋਵੇ, ਬੰਦ ਰਹਿੰਦਾ ਹੈ।

setup

ਸੈੱਟਅੱਪ ਵਿਜ਼ਾਰਡ ਮਾਲਕ ਨੂੰ ਉਨ੍ਹਾਂ ਕਦਮਾਂ ਵਿੱਚੋਂ ਲੰਘਾਉਂਦਾ ਹੈ ਜੋ ਇੱਕ ਫ਼ਾਰਮ ਨਾਲ ਪੂਰੇ ਨਹੀਂ ਹੋ ਸਕਦੇ। form ਕਦਮਾਂ ਦੇ ਮੁੱਲ ਬਾਅਦ ਦੇ generate ਆਰਗੂਮੈਂਟਾਂ ਵਿੱਚ {{key}} ਭਰਦੇ ਹਨ। credentials ਕਦਮਾਂ ਦੇ ਮੁੱਲ ਪਲੱਗਇਨ ਦੇ ਵਾਤਾਵਰਣ ਵੇਰੀਏਬਲਾਂ ਵਜੋਂ ਸੰਭਾਲੇ ਜਾਂਦੇ ਹਨ।

"setup": {
  "title": "Connect Example Chat",
  "steps": [
    { "kind": "form", "title": "Bot name", "fields": [ { "key": "bot_name", "label": "Name", "required": true } ] },
    { "kind": "generate", "title": "App manifest", "command": "manifest", "args": ["--name", "{{bot_name}}"], "outputFormat": "yaml" },
    { "kind": "external", "title": "Create the app", "url": "https://example.com/apps", "urlLabel": "Open admin" },
    { "kind": "credentials", "title": "Paste the token", "fields": [ { "key": "EXAMPLE_CHAT_TOKEN", "label": "Token", "inputType": "password", "required": true } ], "verifyCommand": "auth status" }
  ]
}
ਕਦਮ ਦੀ ਕਿਸਮਫ਼ੀਲਡਾਂ
formtitle, description, fields
generatetitle, description, command, args, outputFormat (yaml, json, toml, text), buttonLabel। ਕਾਪੀ ਕਰਨ ਲਈ ਕਮਾਂਡ ਦਾ ਆਉਟਪੁਟ ਦਿਖਾਉਂਦਾ ਹੈ।
externaltitle, description, url, urlLabel, instructions
credentialstitle, description, fields, verifyCommand। ਜਦੋਂ verifyCommand ਸਫ਼ਲ ਹੁੰਦੀ ਹੈ ਤਾਂ ਕਦਮ ਪੂਰਾ ਹੁੰਦਾ ਹੈ।

ਫ਼ੀਲਡਾਂ ਵਿੱਚ key, label, default, placeholder, maxLength, help, inputType (text, textarea, password) ਅਤੇ required ਹੁੰਦੇ ਹਨ।