ਪਲੱਗਇਨ ਕਿਵੇਂ ਕੰਮ ਕਰਦੇ ਹਨ
ਪਲੱਗਇਨ ਇੱਕ ਐਗਜ਼ੀਕਿਊਟੇਬਲ ਅਤੇ ਇੱਕ ਮੈਨੀਫ਼ੈਸਟ ਹੈ। Nebo ਕਾਲਾਂ ਦੇ ਵਿਚਕਾਰ ਕੋਈ ਪਲੱਗਇਨ ਪ੍ਰੋਸੈਸ ਚੱਲਦਾ ਨਹੀਂ ਰੱਖਦਾ। ਹਰ ਵਾਰ ਜਦੋਂ ਕੋਈ ਕਰਮਚਾਰੀ ਪਲੱਗਇਨ ਵਰਤਦਾ ਹੈ, Nebo ਬਾਈਨਰੀ ਨੂੰ ਇੱਕ ਕਮਾਂਡ ਅਤੇ ਆਰਗੂਮੈਂਟਾਂ ਨਾਲ ਚਾਲੂ ਕਰਦਾ ਹੈ, ਇਸ ਦੇ ਬੰਦ ਹੋਣ ਦੀ ਉਡੀਕ ਕਰਦਾ ਹੈ, ਅਤੇ ਆਉਟਪੁਟ ਕਰਮਚਾਰੀ ਨੂੰ ਵਾਪਸ ਦਿੰਦਾ ਹੈ।
- ਕਮਾਂਡਾਂ ਆਰਗੂਮੈਂਟ ਹਨ। ਕਰਮਚਾਰੀ ਇੱਕ ਕਮਾਂਡ ਚੁਣਦਾ ਹੈ, ਜਿਵੇਂ
notes search, ਅਤੇ ਨਾਮ ਵਾਲੇ ਆਰਗੂਮੈਂਟ। Nebo ਹਰ ਆਰਗੂਮੈਂਟ ਨੂੰ--name valueਵਜੋਂ ਭੇਜਦਾ ਹੈ। ਕੋਈ ਸ਼ੈੱਲ ਨਹੀਂ ਹੈ, ਇਸ ਲਈ ਪਾਈਪ ਅਤੇ ਰੀਡਾਇਰੈਕਟ ਕਦੇ ਲਾਗੂ ਨਹੀਂ ਹੁੰਦੇ। - ਆਉਟਪੁਟ stdout ਹੈ। ਨਤੀਜੇ stdout ’ਤੇ ਲਿਖੋ। JSON ਵਧੀਆ ਕੰਮ ਕਰਦਾ ਹੈ।
- ਸਟੈਂਡਰਡ ਇਨਪੁਟ ਬੰਦ ਹੁੰਦਾ ਹੈ ਆਮ ਕਾਲਾਂ ਲਈ। ਹੁੱਕ, ਰੂਟ ਅਤੇ ਚੈਟ ਪ੍ਰੋਵਾਈਡਰ stdin ਵਰਤਦੇ ਹਨ; plugin.json ਹਵਾਲਾ ਦੇਖੋ।
ਹਰ ਇੰਸਟਾਲ ਅਤੇ ਚਾਲੂ ਕੀਤਾ ਪਲੱਗਇਨ ਕਰਮਚਾਰੀਆਂ ਨੂੰ plugin__<slug> ਨਾਮ ਦੇ ਇੱਕ ਟੂਲ ਵਜੋਂ ਦਿਸਦਾ ਹੈ। ਕਰਮਚਾਰੀ ਇਸ ਨੂੰ ਇਸ ਤਰ੍ਹਾਂ ਕਾਲ ਕਰਦਾ ਹੈ:
{
"command": "notes search",
"args": { "query": "quarterly plan", "limit": "5" },
"display": "Search notes for the quarterly plan"
} Nebo ਚਲਾਉਂਦਾ ਹੈ:
notes-sync notes search --query "quarterly plan" --limit 5
| ਪੈਰਾਮੀਟਰ | ਕਿਸਮ | ਅਰਥ |
|---|---|---|
command | ਸਟ੍ਰਿੰਗ, ਲਾਜ਼ਮੀ | ਪਲੱਗਇਨ ਕਮਾਂਡ ਅਤੇ ਕੋਈ ਵੀ ਸਥਿਤੀ ਵਾਲੇ ਸ਼ਬਦ। |
args | ਸਟ੍ਰਿੰਗਾਂ ਦਾ ਆਬਜੈਕਟ | ਨਾਮ ਵਾਲੇ ਆਰਗੂਮੈਂਟ। ਹਰ ਇੱਕ --key value ਬਣਦਾ ਹੈ। |
timeout | integer | ਉਡੀਕ ਦੇ ਸਕਿੰਟ। ਡਿਫ਼ੌਲਟ 120, ਮੈਨੀਫ਼ੈਸਟ ਦੇ permissions.maxTimeoutSeconds ਨਾਲ ਸੀਮਤ। |
display | string | ਉਹ ਵਾਕ ਜੋ ਮਾਲਕ ਨੂੰ ਦਿਸਦਾ ਹੈ ਜਦੋਂ ਕਾਲ ਨੂੰ ਮਨਜ਼ੂਰੀ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ। |
ਆਪਣਾ ਪਹਿਲਾ ਪਲੱਗਇਨ ਬਣਾਓ
ਕਿਸੇ ਵੀ ਭਾਸ਼ਾ ਵਿੱਚ ਇੱਕ ਬਾਈਨਰੀ ਲਿਖੋ ਜੋ ਆਰਗੂਮੈਂਟਾਂ ਤੋਂ ਆਪਣੀ ਕਮਾਂਡ ਪੜ੍ਹੇ ਅਤੇ ਨਤੀਜਾ ਪ੍ਰਿੰਟ ਕਰੇ। ਫਿਰ ਇਸ ਨੂੰ ਕਿਸੇ ਬੋਟ ਦੀ ਯੂਜ਼ਰ ਪਲੱਗਇਨ ਡਾਇਰੈਕਟਰੀ ਵਿੱਚ plugin.json ਦੇ ਨਾਲ ਰੱਖੋ।
<data>/user/plugins/notes-sync/
├── plugin.json # runtime manifest
├── notes-sync # your binary, named after the slug
└── skills/ # optional: skills that teach employees to use it
└── notes-sync/
└── SKILL.md {
"id": "notes-sync",
"slug": "notes-sync",
"name": "Notes Sync",
"version": "0.1.0",
"description": "Search, read and create notes in Example Notes.",
"platforms": {}
} id, slug, name, version ਅਤੇ platforms ਲਾਜ਼ਮੀ ਹਨ। ਯੂਜ਼ਰ ਪਲੱਗਇਨ ਡਾਇਰੈਕਟਰੀ ਵਿੱਚ platforms ਨਕਸ਼ਾ ਖ਼ਾਲੀ ਹੋ ਸਕਦਾ ਹੈ: Nebo slug ਦੇ ਨਾਮ ਵਾਲੀ ਬਾਈਨਰੀ ਪਹਿਲਾਂ plugin.json ਦੇ ਨਾਲ, ਫਿਰ target/release/ ਅਤੇ target/debug/ ਵਿੱਚ ਲੱਭਦਾ ਹੈ। ਜਦੋਂ ਤੁਸੀਂ ਪ੍ਰਕਾਸ਼ਿਤ ਕਰਦੇ ਹੋ, ਮਾਰਕੀਟਪਲੇਸ ਤੁਹਾਡੀ ਅੱਪਲੋਡ ਕੀਤੀ ਹਰ ਬਾਈਨਰੀ ਲਈ platforms ਭਰ ਦਿੰਦਾ ਹੈ।
<data> macOS ’ਤੇ ~/Library/Application Support/Nebo, Windows ’ਤੇ %APPDATA%\Nebo, ਅਤੇ Linux ’ਤੇ ~/.local/share/nebo ਹੈ, ਜਾਂ NEBO_HOME ਦਾ ਮੁੱਲ। ਯੂਜ਼ਰ ਡਾਇਰੈਕਟਰੀ ਵਿਚਲਾ ਪਲੱਗਇਨ ਉਸੇ slug ਵਾਲੇ ਮਾਰਕੀਟਪਲੇਸ ਪਲੱਗਇਨ ਦੀ ਥਾਂ ਲੈਂਦਾ ਹੈ, ਜਿਸ ਕਰਕੇ ਨਵੀਂ ਬਿਲਡ ਟੈਸਟ ਕਰਨ ਲਈ ਇਹੀ ਥਾਂ ਹੈ।
ਕਰਮਚਾਰੀਆਂ ਨੂੰ ਇਸ ਦੀ ਵਰਤੋਂ ਸਿਖਾਓ
plugin.json ਦੇ ਨਾਲ ਇੱਕ skills/ ਫੋਲਡਰ ਰੱਖੋ। ਇਸ ਵਿਚਲਾ ਹਰ ਸਕਿੱਲ, ਪਲੱਗਇਨ ਇੰਸਟਾਲ ਰਹਿਣ ਤੱਕ, ਹਰ ਕਰਮਚਾਰੀ ਲਈ ਉਪਲਬਧ ਹੁੰਦਾ ਹੈ, ਅਤੇ ਆਪਣੇ ਆਪ ਪਲੱਗਇਨ ਨੂੰ ਨਿਰਭਰਤਾ ਵਜੋਂ ਦਰਜ ਕਰਦਾ ਹੈ। ਸਕਿੱਲ ਵਿੱਚ ਦੱਸੋ ਕਿ ਕਿਹੜੀਆਂ ਕਮਾਂਡਾਂ ਮੌਜੂਦ ਹਨ, ਉਹ ਕੀ ਵਾਪਸ ਕਰਦੀਆਂ ਹਨ, ਅਤੇ ਹਰ ਇੱਕ ਕਦੋਂ ਵਰਤਣੀ ਹੈ। ਸਭ ਤੋਂ ਲਾਭਦਾਇਕ ਸਕਿੱਲਾਂ ਦੇ ਨਾਮ entrySkills ਵਿੱਚ ਦਿਓ ਤਾਂ ਜੋ ਪਲੱਗਇਨ ਦੇ ਟੂਲ ਦਾ ਵੇਰਵਾ ਸਭ ਤੋਂ ਪਹਿਲਾਂ ਉਹਨਾਂ ਵੱਲ ਇਸ਼ਾਰਾ ਕਰੇ।
ਮਾਰਕੀਟਪਲੇਸ ਲਿਸਟਿੰਗ ਇੱਕ ਵੱਖਰੀ ਫ਼ਾਈਲ ਹੈ, PLUGIN.md। Nebo ਇਸ ਨੂੰ ਚੱਲਣ ਵੇਲੇ ਨਹੀਂ ਪੜ੍ਹਦਾ; ਇਹ ਉਹ ਸਫ਼ਾ ਹੈ ਜੋ ਲੋਕ ਇੰਸਟਾਲ ਕਰਨ ਤੋਂ ਪਹਿਲਾਂ ਦੇਖਦੇ ਹਨ। ਪਲੱਗਇਨ ਭੇਜਣਾ ਦੇਖੋ।
ਵਾਤਾਵਰਣ
ਹਰ ਕਾਲ ਬੋਟ ਦਾ ਵਾਤਾਵਰਣ ਵਿਰਾਸਤ ਵਿੱਚ ਲੈਂਦੀ ਹੈ, ਲੋਡਰ ਅਤੇ ਸ਼ੈੱਲ-ਇੰਜੈਕਸ਼ਨ ਵੇਰੀਏਬਲ ਹਟਾ ਕੇ, ਫਿਰ ਇਹ ਮੁੱਲ ਜੋੜਦੀ ਹੈ। ਬਾਅਦ ਵਾਲੀਆਂ ਐਂਟਰੀਆਂ ਨੂੰ ਤਰਜੀਹ ਮਿਲਦੀ ਹੈ।
| ਵੇਰੀਏਬਲ | ਮੁੱਲ |
|---|---|
auth.env ਕੁੰਜੀਆਂ | ਮੈਨੀਫ਼ੈਸਟ ਤੋਂ ਡਿਫ਼ੌਲਟ। |
<SLUG>_BIN | ਇਸ ਪਲੱਗਇਨ ਦੀ ਬਾਈਨਰੀ ਦਾ ਪਾਥ, ਅਤੇ ਹਰ ਉਸ ਪਲੱਗਇਨ ਦਾ ਜਿਸ ’ਤੇ ਇਹ ਨਿਰਭਰ ਹੈ। slug ਵੱਡੇ ਅੱਖਰਾਂ ਵਿੱਚ ਹੁੰਦਾ ਹੈ ਅਤੇ ਹਾਈਫ਼ਨਾਂ ਦੀ ਥਾਂ ਅੰਡਰਸਕੋਰ। |
NEBO_DATA_DIR | ਪਲੱਗਇਨ ਦਾ ਆਪਣਾ ਡਾਟਾ ਫੋਲਡਰ, <data>/appdata/plugins/<slug>/। ਇਹ ਕੰਮ ਕਰਨ ਵਾਲੀ ਡਾਇਰੈਕਟਰੀ ਵੀ ਹੈ, ਅਤੇ ਅਨਇੰਸਟਾਲ ਤੋਂ ਬਾਅਦ ਵੀ ਬਚੀ ਰਹਿੰਦੀ ਹੈ। |
PATH | ਪਹਿਲਾਂ ਪਲੱਗਇਨ ਫੋਲਡਰ, ਫਿਰ ਵਿਰਾਸਤ ਵਿੱਚ ਮਿਲਿਆ ਪਾਥ। |
| ਸੈਟਿੰਗਾਂ | configSchema ਫ਼ੀਲਡਾਂ ਲਈ ਮਾਲਕ ਵੱਲੋਂ ਸੰਭਾਲੇ ਮੁੱਲ। |
NEBO_AGENT_ID | ਕਾਲ ਕਰਨ ਵਾਲਾ ਕਰਮਚਾਰੀ। |
profileDirEnv | ਇਸ ਕਰਮਚਾਰੀ ਅਤੇ ਖਾਤੇ ਦਾ ਖਾਤਾ ਫੋਲਡਰ, ਜਦੋਂ ਪਲੱਗਇਨ ਖਾਤਿਆਂ ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ। |
permissions.envAllow ਅਤੇ permissions.envDeny ਇਸ ਨੂੰ ਸੀਮਤ ਕਰਦੇ ਹਨ ਕਿ ਪਲੱਗਇਨ ਬੋਟ ਤੋਂ ਕੀ ਵਿਰਾਸਤ ਵਿੱਚ ਲੈਂਦਾ ਹੈ। ਇਹ ਪਲੱਗਇਨ ਦੇ ਆਪਣੇ auth ਵੇਰੀਏਬਲ ਕਦੇ ਨਹੀਂ ਹਟਾਉਂਦੇ।
ਖਾਤੇ ਅਤੇ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲ
ਜੋ ਪਲੱਗਇਨ ਕਿਸੇ ਸੇਵਾ ਵਿੱਚ ਸਾਈਨ ਇਨ ਕਰਦਾ ਹੈ, ਉਸ ਨੂੰ ਹਰ ਕਰਮਚਾਰੀ ਲਈ ਇੱਕ ਖਾਤਾ ਰੱਖਣਾ ਚਾਹੀਦਾ ਹੈ। ਬੁੱਕਕੀਪਰ ਵਿੱਤ ਵਾਲੇ ਲੌਗਇਨ ਨਾਲ ਸਾਈਨ ਇਨ ਕਰਦਾ ਹੈ ਅਤੇ ਅਸਿਸਟੈਂਟ ਆਪਣੇ ਲੌਗਇਨ ਨਾਲ, ਅਤੇ ਕੋਈ ਵੀ ਦੂਜੇ ਦੇ ਟੋਕਨ ਨਹੀਂ ਦੇਖਦਾ। ਤੁਸੀਂ ਇਸ ਦਾ ਐਲਾਨ ਮੈਨੀਫ਼ੈਸਟ ਵਿੱਚ ਕਰਦੇ ਹੋ; ਬਾਕੀ Nebo ਕਰਦਾ ਹੈ।
"auth": {
"type": "env",
"label": "Example Notes account",
"env": { "EXAMPLE_NOTES_TOKEN": "" },
"commands": { "login": "auth login", "status": "auth status", "logout": "auth logout" },
"profileDirEnv": "EXAMPLE_NOTES_CONFIG_DIR"
},
"capabilities": {
"configSchema": [
{ "key": "EXAMPLE_NOTES_TOKEN", "label": "API token", "fieldType": "password", "secret": true, "required": true }
]
} auth.envਕ੍ਰੈਡੈਂਸ਼ੀਅਲਾਂ ਦੇ ਨਾਮ ਦਿੰਦਾ ਹੈ।capabilities.configSchemaਉਹਨਾਂ ਦੇ ਲੇਬਲ ਦਿੰਦਾ ਹੈ ਅਤੇ ਕਨੈਕਟ ਫ਼ਾਰਮ ਵਿੱਚ ਉਹਨਾਂ ਦਾ ਕ੍ਰਮ ਤੈਅ ਕਰਦਾ ਹੈ।auth.profileDirEnvਉਸ ਵੇਰੀਏਬਲ ਦਾ ਨਾਮ ਦਿੰਦਾ ਹੈ ਜਿਸ ਤੋਂ ਤੁਹਾਡਾ ਪਲੱਗਇਨ ਆਪਣਾ ਕ੍ਰੈਡੈਂਸ਼ੀਅਲ ਫੋਲਡਰ ਪੜ੍ਹਦਾ ਹੈ। Nebo ਹਰ ਕਰਮਚਾਰੀ ਅਤੇ ਖਾਤੇ ਲਈ ਇੱਕ ਫੋਲਡਰ ਬਣਾਉਂਦਾ ਹੈ ਅਤੇ ਹਰ ਕਾਲ ’ਤੇ ਉਹ ਵੇਰੀਏਬਲ ਸੈੱਟ ਕਰਦਾ ਹੈ।- ਜਦੋਂ ਮਾਲਕ ਕੋਈ ਖਾਤਾ ਕਨੈਕਟ ਕਰਦਾ ਹੈ, Nebo ਮਾਲਕ ਵੱਲੋਂ ਲਿਖੇ ਮੁੱਲਾਂ ਅਤੇ ਸੈੱਟ ਕੀਤੇ ਖਾਤਾ ਫੋਲਡਰ ਨਾਲ ਤੁਹਾਡੀ
loginਕਮਾਂਡ ਚਲਾਉਂਦਾ ਹੈ। ਤੁਹਾਡਾ ਪਲੱਗਇਨ ਜੋ ਵੀ ਲੋੜੀਂਦਾ ਹੈ ਉਸ ਫੋਲਡਰ ਵਿੱਚ ਸੰਭਾਲਦਾ ਹੈ। Nebo ਮੁੱਲ ਆਪਣੇ ਕੋਲ ਨਹੀਂ ਰੱਖਦਾ। - ਤੁਹਾਡੀ
statusਕਮਾਂਡ{"authenticated": true}ਵਰਗਾ JSON ਪ੍ਰਿੰਟ ਕਰਦੀ ਹੈ। ਟੋਕਨ ਦੀ ਮਿਆਦ ਖ਼ਤਮ ਹੋਣ ’ਤੇ, ਜੇ ਤੁਸੀਂrefreshਘੋਸ਼ਿਤ ਕੀਤੀ ਹੈ ਤਾਂ Nebo ਉਸਨੂੰ ਚਲਾਉਂਦਾ ਹੈ।
ਬ੍ਰਾਊਜ਼ਰ ਸਾਈਨ-ਇਨ ਲਈ type ਨੂੰ oauth_cli ’ਤੇ ਸੈੱਟ ਕਰੋ ਅਤੇ login ਤੋਂ ਪ੍ਰੋਵਾਈਡਰ ਦਾ ਸਾਈਨ-ਇਨ URL ਪ੍ਰਿੰਟ ਕਰਵਾਓ ਜਾਂ ਖੁਲ੍ਹਵਾਓ। ਕਰਮਚਾਰੀ ਕਦੇ ਆਪਣੇ ਆਪ ਸਾਈਨ ਇਨ ਨਹੀਂ ਕਰਦੇ: ਜਦੋਂ ਕਿਸੇ ਕਾਲ ਨੂੰ ਲੌਗਇਨ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ, ਮਾਲਕ ਨੂੰ ਇੱਕ ਕਨੈਕਟ ਕਾਰਡ ਦਿਸਦਾ ਹੈ। ਕਈ ਖਾਤਿਆਂ ਵਾਲਾ ਕਰਮਚਾਰੀ ਕਮਾਂਡ ਵਿੱਚ --account <label> ਜੋੜ ਕੇ ਇੱਕ ਚੁਣਦਾ ਹੈ। ਤੁਹਾਡੀ ਬਾਈਨਰੀ ਤੱਕ ਪਹੁੰਚਣ ਤੋਂ ਪਹਿਲਾਂ Nebo ਉਹ ਫ਼ਲੈਗ ਹਟਾ ਦਿੰਦਾ ਹੈ।
ਸੇਵਾ ਦਾ ਨਾਮ ਦਿਓ, ਰੂਪ ਦਾ ਨਹੀਂ। ਪਲੱਗਇਨ ਦਾ ਨਾਮ ਦੱਸਦਾ ਹੈ ਕਿ ਇਹ ਕਿਸ ਨਾਲ ਜੁੜਦਾ ਹੈ, ਜਿਵੇਂ "Example Notes"। ਪਲੱਗਇਨ ਦੇ ਨਾਮ ਵਿੱਚ ਕਦੇ "CLI" ਨਾ ਲਿਖੋ; ਕਰਮਚਾਰੀਆਂ ਅਤੇ ਮਾਲਕਾਂ ਲਈ ਇਹ ਇੱਕ ਕਨੈਕਸ਼ਨ ਹੈ, ਕਮਾਂਡ ਲਾਈਨ ਨਹੀਂ।
ਅੱਗੇ
- plugin.json ਹਵਾਲਾ: ਹਰ ਫ਼ੀਲਡ, ਇਵੈਂਟ, ਹੁੱਕ ਅਤੇ ਟਾਈਪ ਕੀਤੇ ਓਪਰੇਸ਼ਨਾਂ ਸਮੇਤ।
- ਪਲੱਗਇਨ ਭੇਜਣਾ: ਪਲੇਟਫ਼ਾਰਮ, ਬਾਈਨਰੀਆਂ, ਦਸਤਖ਼ਤ ਅਤੇ ਅੱਪਡੇਟ।
- ਪ੍ਰਕਾਸ਼ਨ: ਹਰ ਕਿਸਮ ਦੀ ਚੀਜ਼ ਲਈ ਮਾਰਕੀਟਪਲੇਸ ਦੀ ਪ੍ਰਕਿਰਿਆ।