app/usage/basic_command.html

91 lines
34 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="zh-CN" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="generator" content="VuePress 2.0.0-rc.9" />
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
<style>
html {
background: var(--bg-color, #fff);
}
html[data-theme="dark"] {
background: var(--bg-color, #1d1e1f);
}
body {
background: var(--bg-color);
}
</style>
<script>
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
const systemDarkMode =
window.matchMedia &&
window.matchMedia("(prefers-color-scheme: dark)").matches;
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
document.documentElement.setAttribute("data-theme", "dark");
}
</script>
<meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/usage/basic_command.html"><meta property="og:site_name" content="LiteyukiBot 轻雪机器人"><meta property="og:title" content="基础命令"><meta property="og:description" content="基础插件 轻雪 liteyuki 命令别名 插件/包管理器 liteyuki_pacman 插件管理 资源包管理 命令别名 注意 受限于NoneBot2钩子函数的依赖注入参数插件停用只能阻断传入响应对于主动推送的插件不生效请阅读插件主页的说明。 用户管理liteyuki_user 命令别名 提示 参数:<param>为必填参数,[option]为..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:updated_time" content="2024-06-01T18:23:00.000Z"><meta property="article:author" content="远野千束"><meta property="article:modified_time" content="2024-06-01T18:23:00.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"基础命令","image":[""],"dateModified":"2024-06-01T18:23:00.000Z","author":[{"@type":"Person","name":"远野千束","url":"https://snowykami.me"}]}</script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>基础命令 | LiteyukiBot 轻雪机器人</title><meta name="description" content="基础插件 轻雪 liteyuki 命令别名 插件/包管理器 liteyuki_pacman 插件管理 资源包管理 命令别名 注意 受限于NoneBot2钩子函数的依赖注入参数插件停用只能阻断传入响应对于主动推送的插件不生效请阅读插件主页的说明。 用户管理liteyuki_user 命令别名 提示 参数:<param>为必填参数,[option]为...">
<link rel="preload" href="/assets/style--c6ng4Bd.css" as="style"><link rel="stylesheet" href="/assets/style--c6ng4Bd.css">
<link rel="modulepreload" href="/assets/app-WSA7NPnD.js"><link rel="modulepreload" href="/assets/basic_command.html-B5i-WVaK.js">
<link rel="prefetch" href="/assets/index.html-Dy-LDF-Y.js" as="script"><link rel="prefetch" href="/assets/childrensdaybak.html-DKo-FPvJ.js" as="script"><link rel="prefetch" href="/assets/foolsday.html-4R0P6yR_.js" as="script"><link rel="prefetch" href="/assets/index.html-BTFZXUq4.js" as="script"><link rel="prefetch" href="/assets/config.html-Bp_sRpMk.js" as="script"><link rel="prefetch" href="/assets/fandq.html-CqIsSUDK.js" as="script"><link rel="prefetch" href="/assets/install.html-zLp0QQb9.js" as="script"><link rel="prefetch" href="/assets/index.html-DUk3iXhv.js" as="script"><link rel="prefetch" href="/assets/plugin.html-Bgr4KPDy.js" as="script"><link rel="prefetch" href="/assets/resource.html-s6EflWJ0.js" as="script"><link rel="prefetch" href="/assets/index.html-FVIcyZaR.js" as="script"><link rel="prefetch" href="/assets/agreement.html-4QErmTcH.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-DgXaUx2s.js" as="script"><link rel="prefetch" href="/assets/lyapi.html-C_F1cCiP.js" as="script"><link rel="prefetch" href="/assets/lyfunc.html-Dl8P5mwh.js" as="script"><link rel="prefetch" href="/assets/resource_pack.html-JVo3odQM.js" as="script"><link rel="prefetch" href="/assets/404.html-jDubOTDk.js" as="script"><link rel="prefetch" href="/assets/giscus-7BMGhbDA.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-SzV8tJDW.js" as="script">
</head>
<body>
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot 轻雪机器人</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/" aria-label="首页"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>首页<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/deployment/" aria-label="项目部署"><!---->项目部署<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/usage/" aria-label="使用手册"><!---->使用手册<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/store/resource.html" aria-label="商店"><!---->商店<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><!----><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/snowykami/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><div class="nav-item hide-in-mobile"><button type="button" id="appearance-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" style="display:block;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" style="display:none;"><pat
reload-liteyuki <span class="token comment"># 重载轻雪</span>
update-liteyuki <span class="token comment"># 更新轻雪</span>
liteecho <span class="token comment"># 查看当前bot</span>
status <span class="token comment"># 查看统计信息和状态</span>
config <span class="token builtin class-name">set</span> <span class="token operator">&lt;</span>key<span class="token operator">&gt;</span> value <span class="token comment"># 添加配置项,若存在则会覆盖,输入值会被执行以转换为正确的类型,&quot;10&quot;和10是不一样的</span>
config get <span class="token punctuation">[</span>key<span class="token punctuation">]</span> <span class="token comment"># 查询配置项不带key返回配置项列表推荐私聊使用</span>
switch-image-mode <span class="token comment"># 在普通图片和Markdown大图之间切换该功能需要commit:505468b及以后的Lagrange.OneBot</span>
/api api_name <span class="token punctuation">[</span>args<span class="token punctuation">]</span> <span class="token comment"># 调用机器人API例如/api get_group_member_list group_id=1234567空格用%20</span>
/function function_name <span class="token punctuation">[</span>args<span class="token punctuation">]</span> <span class="token punctuation">[</span>kwargs<span class="token punctuation">]</span> <span class="token comment"># 调用机器人函数,例如/function send_group_msg group_id=1234567 message=hello</span>
<span class="token comment"># 仅超级用户,群聊仅群主、管理员、超级用户可用</span>
group enable/disable <span class="token punctuation">[</span>group_id<span class="token punctuation">]</span> <span class="token comment"># 在群聊启用/停用机器人group_id仅超级用户可用</span>
<span class="token comment"># 所有人可用</span>
liteyuki-docs <span class="token comment"># 查看轻雪文档</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>命令别名</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>status 状态,
reload-liteyuki 重启轻雪,
update-liteyuki 更新轻雪,
reload-resources 重载资源,
config 配置 <span class="token operator">|</span> <span class="token builtin class-name">set</span> 设置 <span class="token operator">|</span> get 查询,
switch-image-mode 切换图片模式,
liteyuki-docs 轻雪文档
group 群聊 <span class="token operator">|</span> <span class="token builtin class-name">enable</span> 启用 <span class="token operator">|</span> disable 停用
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><hr><h3 id="插件-包管理器-liteyuki-pacman" tabindex="-1"><a class="header-anchor" href="#插件-包管理器-liteyuki-pacman"><span><strong>插件/包管理器 <code>liteyuki_pacman</code></strong></span></a></h3><ul><li>插件管理</li></ul><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token comment"># 仅超级用户</span>
<span class="token function">npm</span> update <span class="token comment"># 更新插件商店索引</span>
<span class="token function">npm</span> <span class="token function">install</span> <span class="token operator">&lt;</span>plugin_name<span class="token operator">&gt;</span> <span class="token comment"># 安装插件</span>
<span class="token function">npm</span> uninstall <span class="token operator">&lt;</span>plugin_name<span class="token operator">&gt;</span> <span class="token comment"># 卸载插件</span>
<span class="token function">npm</span> search <span class="token operator">&lt;</span>keywords<span class="token punctuation">..</span>.<span class="token operator">&gt;</span> <span class="token comment"># 通过关键词搜索插件</span>
<span class="token function">npm</span> enable-global/disable-global <span class="token operator">&lt;</span>plugin_name<span class="token operator">&gt;</span> <span class="token comment"># 全局启用/停用插件</span>
<span class="token comment"># 群聊仅群主、管理员、超级用户可用,私聊所有人可用</span>
<span class="token function">npm</span> enable/disable <span class="token operator">&lt;</span>plugin_name<span class="token operator">&gt;</span> <span class="token punctuation">[</span>--group <span class="token operator">&lt;</span>group_id<span class="token operator">&gt;</span><span class="token punctuation">]</span> <span class="token comment"># 当前会话启用/停用插件</span>
<span class="token function">npm</span> list <span class="token punctuation">[</span>page<span class="token punctuation">]</span> <span class="token punctuation">[</span>num<span class="token punctuation">]</span> <span class="token comment"># 列出所有插件 page为页数num为每页显示数量</span>
<span class="token comment"># 所有人</span>
<span class="token builtin class-name">help</span> <span class="token operator">&lt;</span>plugin_name<span class="token operator">&gt;</span> <span class="token comment"># 查看插件帮助</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>资源包管理</li></ul><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token comment"># 仅超级用户</span>
<span class="token function">rpm</span> list <span class="token punctuation">[</span>page<span class="token punctuation">]</span> <span class="token punctuation">[</span>num<span class="token punctuation">]</span> <span class="token comment"># 列出所有资源包 page为页数num为每页显示数量</span>
<span class="token function">rpm</span> load <span class="token operator">&lt;</span>pack_name<span class="token operator">&gt;</span> <span class="token comment"># 加载资源包</span>
<span class="token function">rpm</span> unload <span class="token operator">&lt;</span>pack_name<span class="token operator">&gt;</span> <span class="token comment"># 卸载资源包</span>
<span class="token function">rpm</span> change <span class="token operator">&lt;</span>pack_name<span class="token operator">&gt;</span> <span class="token comment"># 修改优先级</span>
<span class="token function">rpm</span> reload <span class="token comment"># 重载所有资源包</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>命令别名</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">npm</span> 插件管理 <span class="token operator">|</span> update 更新 <span class="token operator">|</span> <span class="token function">install</span> 安装 <span class="token operator">|</span> uninstall 卸载 <span class="token operator">|</span> search 搜索
<span class="token builtin class-name">enable</span> 启用 <span class="token operator">|</span> disable 停用 <span class="token operator">|</span> enable-global 全局启用 <span class="token operator">|</span> disable-global 全局停用 <span class="token operator">|</span> <span class="token parameter variable">--group</span> <span class="token parameter variable">-g</span>
<span class="token function">rpm</span> 资源包 <span class="token operator">|</span> load 加载 <span class="token operator">|</span> unload 卸载 <span class="token operator">|</span> change 更改 <span class="token operator">|</span> reload 重载 <span class="token operator">|</span> list 列表
<span class="token builtin class-name">help</span> 帮助
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container warning"><p class="hint-container-title">注意</p><p>受限于NoneBot2钩子函数的依赖注入参数插件停用只能阻断传入响应对于主动推送的插件不生效请阅读插件主页的说明。</p></div><hr><h3 id="用户管理liteyuki-user" tabindex="-1"><a class="header-anchor" href="#用户管理liteyuki-user"><span><strong>用户管理<code>liteyuki_user</code></strong></span></a></h3><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token comment"># 所有人可用</span>
profile <span class="token comment"># 查看用户信息菜单</span>
profile <span class="token builtin class-name">set</span> <span class="token operator">&lt;</span>key<span class="token operator">&gt;</span> <span class="token punctuation">[</span>value<span class="token punctuation">]</span> <span class="token comment"># 设置用户信息或打开属性设置菜单</span>
profile get <span class="token operator">&lt;</span>key<span class="token operator">&gt;</span> <span class="token comment"># 获取用户信息</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>命令别名</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>profile 个人信息 <span class="token operator">|</span> <span class="token builtin class-name">set</span> 设置 <span class="token operator">|</span> get 查询
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="hint-container tip"><p class="hint-container-title">提示</p><p><strong>参数</strong><code>&lt;param&gt;</code>为必填参数,<code>[option]</code>为可选参数。</p><p><strong>命令别名</strong>:配置了命令别名的命令可以使用别名代替原命令,例如<code>npm install ~</code>可以使用<code>插件 安装 ~</code>代替。</p></div></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/snowykami/LiteyukiBot/edit/main/docs/usage/basic_command.md" rel="noopener noreferrer" target="_blank" aria-label="在 GitHub 上编辑此页" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->在 GitHub 上编辑此页<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="meta-item git-info"><div class="update-time"><span class="label">上次编辑于: </span><!----></div><div class="contributors"><span class="label">贡献者: </span><!--[--><!--[--><span class="contributor" title="email: snowykami@outlook.com">snowy</span>,<!--]--><!--[--><span class="contributor" title="email: 79104275+snowykami@users.noreply.github.com">Snowykami</span><!--]--><!--]--></div></div></footer><nav class="vp-page-nav"><!----><a class="route-link nav-link next" href="/usage/extra_command.html" aria-label="功能命令"><div class="hint">下一页<span class="arrow end"></span></div><div class="link">功能命令<span class="font-icon icon fa-fw fa-sm fas fa-comment" style=""></span></div></a></nav><div id="vp-comment" class="giscus-wrapper input-top" style="display:block;"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" preserveAspectRatio="xMidYMid" viewBox="0 0 100 100"><circle cx="28" cy="75" r="11" fill="currentColor"><animate attributeName="fill-opacity" begin="0s" dur="1s" keyTimes="0;0.2;1" repeatCount="indefinite" values="0;1;1"></animate></circle><path fill="none" stroke="#88baf0" stroke-width="10" d="M28 47a28 28 0 0 1 28 28"><animate attributeName="stroke-opacity" begin="0.1s" dur="1s" keyTimes="0;0.2;1" repeatCount="indefinite" values="0;1;1"></animate></path><path fill="none" stroke="#88baf0" stroke-width="10" d="M28 25a50 50 0 0 1 50 50"><animate attributeName="stroke-opacity" begin="0.2s" dur="1s" keyTimes="0;0.2;1" repeatCount="indefinite" values="0;1;1"></animate></path></svg></div><!--[--><!----><!--]--><!--]--></main><!--]--><footer class="vp-footer-wrapper"><div class="vp-footer">LiteyukiBot</div><div class="vp-copyright">Copyright © 2024 远野千束 </div></footer></div><!--]--><!--[--><!----><!--]--><!--]--></div>
<script type="module" src="/assets/app-WSA7NPnD.js" defer></script>
</body>
</html>