1# SHELL
2
3OpenHarmony内核提供的Shell支持调试常用的基本功能，包含系统、文件、网络相关命令。同时OpenHarmony内核的Shell支持添加新的命令，可以根据需求来进行定制。
4
5Shell功能仅供调试使用，暂不支持tab按键补全，按键回退等功能。
6
7部分命令需要通过make menuconfig开启对应选项才可使用。
8
9## 常用命令介绍
10
11### cat
12
13用于显示文本文件的内容。需开启LOSCFG_FS_VFS。
14
15###### 命令格式
16
17cat [FILE]
18
19###### 参数说明
20
21| 参数 | 参数说明   | 取值范围       |
22| ---- | ---------- | -------------- |
23| FILE | 文件路径。 | 已存在的文件。 |
24
25### cd
26
27用来改变当前目录。需开启LOSCFG_FS_VFS。
28
29###### 命令格式
30
31cd [path]
32
33###### 参数说明
34
35| 参数 | 参数说明   | 取值范围       |
36| ---- | ---------- | -------------- |
37| path | 文件路径。 | 已存在的路径。 |
38
39### cp
40
41拷贝文件，创建一份副本。需开启LOSCFG_FS_VFS。
42
43###### 命令格式
44
45cp [SOURCEFILE] [DESTFILE]
46
47###### 参数说明
48
49| 参数       | 参数说明               | 取值范围                                  |
50| ---------- | ---------------------- | ----------------------------------------- |
51| SOURCEFILE | 源文件路径。文件路径。 | 目前只支持文件,不支持目录；文件不可为空。 |
52| DESTFILE   | 目的文件路径。         | 支持目录以及文件名；目录需有效。          |
53
54### date
55
56用于查询系统日期和时间。
57
58###### 命令格式
59
60date
61
62###### 参数说明
63
64无
65
66### free
67
68显示系统内存的使用情况。
69
70###### 命令格式
71
72free [ -k | -m ]
73
74###### 参数说明
75
76| 参数 | 参数说明          | 取值范围 |
77| ---- | ----------------- | -------- |
78| -k   | 以KiB为单位显示。 | N/A      |
79| -m   | 以MiB为单位显示。 | N/A      |
80
81### help
82
83显示当前操作系统内所有操作指令。
84
85###### 命令格式
86
87help
88
89###### 参数说明
90
91无
92
93### ifconfig
94
95用来查询网卡的IP地址、网络掩码、网关、硬件mac地址等参数。需开启LWIP_SHELLCMD_ENABLE。
96
97###### 命令格式
98
99ifconfig
100
101###### 参数说明
102
103无
104
105### ls
106
107用来显示当前目录的内容。需开启LOSCFG_FS_VFS。
108
109###### 命令格式
110
111###### ls  [DIRECTORY]
112
113| 参数      | 参数说明   | 取值范围                                                     |
114| --------- | ---------- | ------------------------------------------------------------ |
115| DIRECTORY | 文件路径。 | DIRECTORY为空时，显示当前目录的内容。<br/>DIRECTORY为有效目录路径时，会显示对应目录下的内容。<br/>当前LiteOS-M不支持根目录 "/"。 |
116
117### memusage
118
119用来显示内存使用水线。
120
121###### 命令格式
122
123###### memusage [-k/-m]
124
125| 参数 | 参数说明          | 取值范围 |
126| ---- | ----------------- | -------- |
127| -k   | 以KiB为单位显示。 | N/A      |
128| -m   | 以MiB为单位显示。 | N/A      |
129
130### mkdir
131
132用来创建一个目录。需开启LOSCFG_FS_VFS。
133
134###### 命令格式
135
136###### mkdir [DIRECTORY]
137
138| 参数      | 参数说明   | 取值范围                              |
139| --------- | ---------- | ------------------------------------- |
140| DIRECTORY | 文件路径。 | DIRECTORY可以传入绝对路径和相对路径。 |
141
142### ping
143
144用来测试网络连接是否正常。需开启LWIP_SHELLCMD_ENABLE。
145
146###### 命令格式
147
148###### ping [ip]
149
150| 参数 | 参数说明                       | 取值范围 |
151| ---- | ------------------------------ | -------- |
152| ip   | 要测试是否网络连通的IPv4地址。 | N/A      |
153
154### pwd
155
156用来显示当前路径。需开启LOSCFG_FS_VFS。
157
158###### 命令格式
159
160###### pwd
161
162### rm
163
164用来删除文件或文件夹。需开启LOSCFG_FS_VFS。
165
166###### 命令格式
167
168###### rm [FILE] or rm [-r/-R] [FILE]
169
170| 参数  | 参数说明                        | 取值范围                         |
171| ----- | ------------------------------- | -------------------------------- |
172| FILE  | 文件名，可以是文件或者文件夹 。 | FILE可以传入绝对路径和相对路径。 |
173| -r/-R | FILE是文件夹时需要有-r /-R。    | N/A                              |
174
175### rmdir
176
177用来删除文件夹。需开启LOSCFG_FS_VFS。
178
179###### 命令格式
180
181###### rmdir [DIRECTORY]
182
183| 参数      | 参数说明   | 取值范围                              |
184| --------- | ---------- | ------------------------------------- |
185| DIRECTORY | 文件路径。 | DIRECTORY可以传入绝对路径和相对路径。 |
186
187### task
188
189用来显示当前各任务状态。
190
191###### 命令格式
192
193###### task
194
195显示内容主要包括任务号，优先级，状态，栈信息，信号，事件，CPU占用率，任务名称等
196
197### touch
198
199用来创建文件。需开启LOSCFG_FS_VFS。
200
201###### 命令格式
202
203###### touch [FILE]
204
205| 参数 | 参数说明 | 取值范围                         |
206| ---- | -------- | -------------------------------- |
207| FILE | 文件名。 | FILE可以传入绝对路径和相对路径。 |
208
209### stack
210
211用来查看指定任务的栈内容。需开启编译选项 LOSCFG_DEBUG_TOOLS，功能开启会影响性能。
212
213###### 命令格式
214
215###### stack [ID]
216
217| 参数 | 参数说明 | 取值范围                 |
218| ---- | -------- | ------------------------ |
219| ID   | 任务ID。 | 任务ID对应的任务需存在。 |
220
221### hwi
222
223用来查看中断的占用率。需开启编译选项 LOSCFG_DEBUG_TOOLS，功能开启会影响性能。
224
225###### 命令格式
226
227###### hwi
228
229### st
230
231用来查看调度信息。需开启编译选项 LOSCFG_DEBUG_TOOLS，功能开启会影响性能。
232
233###### 命令格式
234
235###### st -s | st -e
236
237| 参数 | 参数说明               | 取值范围 |
238| ---- | ---------------------- | -------- |
239| -s   | 开始记录调度信息       | N/A      |
240| -e   | 停止记录并打印调度信息 | N/A      |
241
242