forked from x/ContextOS
hub add 添加了命令使用说明
This commit is contained in:
shy
GitHub
parent
bcf246c9a9
commit
4fb3f489be
136
README.md
136
README.md
@ -1,11 +1,143 @@
|
|||||||
# context
|
## 0. context简介
|
||||||
context: 通过提供自由的模块，简洁的接口，动态的结构，让编程变得更简单，让世界变得更美好。
|
context: 终端工具链，各种实用的功能模块，通过简洁的接口，自由的组合在一起。
|
||||||
|
|
||||||
|
作为一个工具箱，内置各种实用工具，通过灵活的配置，打造个性化的工具链。
|
||||||
|
|
||||||
|
作为一个框架，通过模块式开发，可以快速开发各种应用软件。
|
||||||
|
|
||||||
|
## 1.context安装
|
||||||
|
* 下载：git clone https://github.com/shylinux/context
|
||||||
|
* 编译：cd context && go install src/example/bench.go
|
||||||
|
## 2. context使用
|
||||||
|
### 2.0 应用示例--启动WEB服务器
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ bench
|
||||||
|
> ~web
|
||||||
|
> serve ./ ':9090'
|
||||||
|
```
|
||||||
|
在shell中，运行命令bench，启动应用，进入到一个类似于shell的环境中。
|
||||||
|
|
||||||
|
执行"~web"，切换到web模块，执行"serve ./ ':9090'"，在当前目录启动一个WEB服务器，监听地址为"0.0.0.0:9090"。
|
||||||
|
|
||||||
|
打开浏览器输入"http://localhost:9090" ，即可看一个静态WEB服务器已经启动。
|
||||||
|
### 2.1 常用命令
|
||||||
|
#### 2.1.1 cache: 缓存管理
|
||||||
|
```sh
|
||||||
|
web> cache
|
||||||
|
address(:9090): 服务地址
|
||||||
|
directory(./): 服务目录
|
||||||
|
protocol(http): 服务协议
|
||||||
|
```
|
||||||
|
输入"cache"命令，即可查看当前模块的缓存数据，通过这些缓存数据，就可以了解模块的当前各种运行状态。如"address"，代表web模块监听的网络地址为"0.0.0.0:9090"。
|
||||||
|
#### 2.1.2 config: 配置管理
|
||||||
|
```sh
|
||||||
|
web> config
|
||||||
|
logheaders(yes): 日志输出报文头(yes/no)
|
||||||
|
```
|
||||||
|
输入"config"命令，即可查看当前模块的配置信息。通过修改这些配置信息，就可以控制模块的运行的环境，改变模块运行的状态。如"logheaders"，代表web模块处理网络请求时，是否在日志中输出报文头，此时值为yes即打印报文头。
|
||||||
|
```sh
|
||||||
|
web> config logheaders no
|
||||||
|
web> config
|
||||||
|
logheaders(no): 日志输出报文头(yes/no)
|
||||||
|
```
|
||||||
|
输入"config logheaders no"命令，修改logheaders的值为no，即不在日志中输出报文头。
|
||||||
|
#### 2.1.3 command: 命令管理
|
||||||
|
```sh
|
||||||
|
web> command
|
||||||
|
serve: serve [directory [address [protocol]]]
|
||||||
|
route: route directory|template|script route content
|
||||||
|
/demo: /demo
|
||||||
|
```
|
||||||
|
输入"command"命令，即可查看当前模块的命令集合。通过调用这些命令使用模块提供的各种功能。如"serve"，启动一个web服务器，参数都是可选的，参数"directory"代表web服务器的响应路径，存放网页的各种文件。参数"address"，代表服务器监听的网络地址。参数"protocol"，代表服务器使用的网络协议。
|
||||||
|
#### 2.1.4 context: 模块管理
|
||||||
|
```sh
|
||||||
|
web> context
|
||||||
|
web(ctx:cli:aaa::): start(:9090) 应用中心
|
||||||
|
```
|
||||||
|
输入"context"命令，即可查看当前模块及子模块的基本信息。web模块没有子模块，所以这里只显示了web模块的基本信息。
|
||||||
|
```sh
|
||||||
|
web> context ctx
|
||||||
|
ctx> context
|
||||||
|
ctx(:cli:aaa:root:root): begin() 模块中心
|
||||||
|
lex(ctx::aaa:root:root): start(52,19,0) 词法中心
|
||||||
|
yac(ctx::aaa:root:root): start(26,13,21) 语法中心
|
||||||
|
cli(ctx:cli:aaa:root:root): start(stdio) 管理中心
|
||||||
|
ssh(ctx:cli:aaa:root:root): begin() 集群中心
|
||||||
|
mdb(ctx:cli:aaa:root:root): begin() 数据中心
|
||||||
|
tcp(ctx::aaa:root:root): begin() 网络中心
|
||||||
|
web(ctx:cli:aaa:root:root): begin() 应用中心
|
||||||
|
aaa(ctx::aaa:root:root): start(root) 认证中心
|
||||||
|
nfs(ctx::aaa:root:root): begin() 存储中心
|
||||||
|
log(ctx::aaa:root:root): begin() 日志中心
|
||||||
|
file1(nfs::aaa:root:root): start(var/bench.log) 打开文件
|
||||||
|
stdio(nfs::aaa:root:root): start(stdio) 扫描文件
|
||||||
|
file2(nfs::aaa:root:root): start(etc/init.shy) 扫描文件
|
||||||
|
```
|
||||||
|
输入"context ctx"命令，切换ctx模块为当前模块。输入"context"命令，即可查看当前模块及子模块的基本信息。ctx为根模块，所以可以查看到所有模块的基本信息。
|
||||||
|
#### 2.1.5 message: 消息管理
|
||||||
|
```sh
|
||||||
|
tcp> message
|
||||||
|
requests:
|
||||||
|
0 9(ctx->tcp): 23:30:19 []
|
||||||
|
sessions:
|
||||||
|
historys:
|
||||||
|
0 9(ctx->tcp): 23:30:19 []
|
||||||
|
1 4358(cli->tcp): 23:30:22 [context tcp]
|
||||||
|
0 4359(cli->log): 23:30:22 [log cmd 2 context [tcp] []]
|
||||||
|
1 4361(tcp->log): 23:30:22 [log search 1 match [tcp]]
|
||||||
|
2 4363(cli->tcp): 23:30:22 []
|
||||||
|
```
|
||||||
|
输入"message"命令，查看当前模块收发的所有消息。其中"requests"是收到的长消息，如有一条ctx模块发送给tcp模块的编号为9消息。其中"sessions"，是发送出的长消息，这里为空，所以tcp模块没有发送长消息。其中"historys"是模块收到的所以消息，包括长消息和短消息。显示中除了显示当前消息，还会显示消息的子消息。
|
||||||
|
```sh
|
||||||
|
tcp> message 9
|
||||||
|
message: 0
|
||||||
|
9(ctx->tcp): 23:36:48 []
|
||||||
|
```
|
||||||
|
输入"message 9"命令，查看编号为9的消息的具体信息。
|
||||||
|
### 2.2 web模块的命令
|
||||||
|
web模块，提供web服务。目前有两条命令serve主机管理，route路由管理。
|
||||||
|
```sh
|
||||||
|
web> command
|
||||||
|
serve: serve [directory [address [protocol]]]
|
||||||
|
route: route directory|template|script route content
|
||||||
|
/demo: /demo
|
||||||
|
```
|
||||||
|
#### 2.2.1 serve主机管理
|
||||||
|
```sh
|
||||||
|
web> command serve
|
||||||
|
serve [directory [address [protocol]]]
|
||||||
|
开启应用服务
|
||||||
|
```
|
||||||
|
* directory服务目录
|
||||||
|
* address服务地址(ip:port)
|
||||||
|
* protocol服务协议(http/https)
|
||||||
|
|
||||||
|
#### 2.2.2 route路由管理
|
||||||
|
```sh
|
||||||
|
web> command route
|
||||||
|
route directory|template|script route content
|
||||||
|
添加应用内容
|
||||||
|
```
|
||||||
|
参数route代表http请求的uri地址，参数content代表响应回复的内容，不同类型的服务有不同的意义。
|
||||||
|
* directory静态服务
|
||||||
|
|
||||||
|
content代表路径，即web服务请求此route路径时，回复的内容为content指定的目录或文件。
|
||||||
|
* template模板服务
|
||||||
|
|
||||||
|
content代表模板，即web服务请求此route路径时，回复的内容为content指定的模板被数据填充后的内容。
|
||||||
|
* script脚本服务
|
||||||
|
|
||||||
|
content代表脚本的文件名，即web服务请求此route路径时，回复的内容为content指定的脚本运行后输出的内容。
|
||||||
|
|
||||||
|
## 3. context开发
|
||||||
|
|
||||||
## 数据结构
|
## 数据结构
|
||||||
* ARM: 寻址与指令
|
* ARM: 寻址与指令
|
||||||
* Linux: 文件与进程
|
* Linux: 文件与进程
|
||||||
* HTTP: 表示与会话
|
* HTTP: 表示与会话
|
||||||
|
|
||||||
|
|
||||||
## 开发流程
|
## 开发流程
|
||||||
* 设计: 协议与流程
|
* 设计: 协议与流程
|
||||||
* 编程: 接口与框架
|
* 编程: 接口与框架
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user