v0.9.0 release

Author: Moe-hacker

README.md

@@ -5,26 +5,26 @@
 [![Build release](https://github.com/RuriOSS/rurima/actions/workflows/build.yml/badge.svg)](https://github.com/RuriOSS/rurima/actions/workflows/build.yml)
 
 ![](https://img.shields.io/badge/Powered%20By-GNU%20C-00d000?style=flat&labelColor=gray&logo=C)
-
+# The first release:
+v0.9.0 is the first release of rurima, some feature are still WIP, but it is already usable as the extended version of ruri.      
 # About:
 So, what is rurima?       
 The enhanced version of ruri.          
 ruri only focus on running container, but rurima can also provide the function of getting rootfs image and backup/restore.          
 And it will be a more powerful container manager in the fulture.            
 With the `docker` and `lxc` subcommand of rurima, you can search & get & unpack images from dockerhub or LXC mirror easily.       
-# Not Only Ruri Container Manager:
+## Not Only Ruri Container Manager:
 Rurima was planned to be the ruri container manager, but as rurima has a full integration of ruri now, you can just use it as a more powerful version of ruri, although the container manager function is still WIP.               
 For more info about ruri, see [ruri](https://github.com/Moe-hacker/ruri)      
-# Note & WIP:
+## Note & WIP:
 This project does not follow OCI and can only be a `PARTIAL` replacement of docker, this project is still under development.       
-# Terms of Use:
+## Terms of Use:
 See [TERMS_OF_USE.md](TERMS_OF_USE.md)
-# For Android user:
+## For Android user:
 You might need to root your phone before using rurima, some container might not work properly with proot.  
-
-# What's new:
-You can use `rurima ota` to update rurima automatically now.      
-And, we are working for the migration from daijin, so rurima will fully replace it in the future.      
+# Full usage doc:
+For a full usage documentation,    
+See [USAGE.md](doc/USAGE.md)
 # WARNING:      
 ```
 * Your warranty is void.
@@ -53,48 +53,6 @@ rurima pull whyour/qinglong ./test
 rurima pull ubuntu ./test
 ```
 It will search lxc image first, if not found, it will auto try to pull rootfs from dockerhub.      
-# Example usage of docker subcommand:
-Get `alpine` image, use tag `edge`, save to `./test`     
-```sh
-rurima docker pull -i alpine -t edge -s ./test
-```     
-Get `whyour/qinglong` docker image.      
-```sh
-rurima docker pull -i whyour/qinglong -s ./test
-```
-Get `ubuntu` docker image.      
-```sh
-rurima docker pull -i ubuntu -s ./test
-```
-Search for image `ubuntu`:      
-```sh
-rurima docker search -i ubuntu
-```
-Search tag for `ubuntu`:      
-```sh
-rurima docker tag -i ubuntu
-```
-Use docker mirror `dockerpull.org`
-```sh
-rurima docker pull -m dockerpull.org -i ubuntu -s ./test
-```
-Try every mirrorlist:      
-```sh
-rurima docker pull -T -i ubuntu -s ./test
-```
-Try fallback mode:      
-```sh
-rurima docker pull -T -f -i ubuntu -s ./test
-```
-# Example usage of lxc subcommand:
-Pull `alpine` version `edge`.      
-```sh
-rurima lxc pull -o alpine -v edge -s ./test
-```
-Use `mirrors.bfsu.edu.cn/lxc-images` as mirror:   
-```sh
-rurima lxc pull -m mirrors.bfsu.edu.cn/lxc-images -o alpine -v edge -s ./test
-```    
 # About suid or caps:
 Rurima does not allow to set any suid/sgid (with root) or capability on it, it will check it in main() and error() if detected these unsafe settings.      
 So, please always use sudo instead.     
@@ -130,20 +88,6 @@ and finally, tar -xvf *.apk to unpack it. So you got proot.static, rename it to
 Manage ruri containers and configs.   
 Config support, a bit like Dockerfile.   
 ....
-# Usage:
-```
-Usage: rurima [subcommand] [options]
-Subcommands:
-  docker: DockerHub support.
-  lxc: LXC mirror support.
-  pull: Pull rootfs.
-  unpack: Unpack rootfs.
-  backup: Backup rootfs.
-  ruri: Built-in ruri command.
-  help: Show help message.
-Options:
-  -h, --help: Show help message.
-```
 ---------
 
 <p align="center">「僕らタイムフライヤー</p>

doc/USAGE.md

@@ -0,0 +1,121 @@
+# Warning:
+Since rurima has not released v1.0, some usage/features may change in the future.      
+# Undocumented part:
+The `run` and `netns` subcommand is WIP, it should not be used by users.    
+# Image source:
+rurima currently supports both lxc-mirror and dockerhub as container image source.      
+# Unified image puller:
+rurima has a unified `pull` subcommand that can pull images easily.    
+## Basic usage:
+```sh
+# pull alpine:edge to ./test:
+rurima pull alpine:edge ./test
+# pull hello-world to ./hello:
+rurima pull hello-world ./hello
+```
+it's a bit like cmdline of docker, but, it will try lxc-mirror first if it found that the image is available there.    
+## Full options:
+```
+Usage: rurima pull <options> [image]:[version] [savedir]
+Options:
+  -h, --help: Show help message.
+  -m, --mirror: Mirror URL.
+  -a, --arch: Architecture.
+  -d, --docker: Only search dockerhub for image.
+  -f, --fallback: Fallback mode, only for docker image.
+```
+All options should be used when you really need.     
+## Examples:
+```sh
+# pull alpine:edge to ./test, but using dockerhub as source:
+rurima pull --docker alpine:edge ./test
+
+# pull hello-world to ./hello, but pull amd64 with fallback mode:
+rurima pull --arch amd64 --fallback hello-world ./hello
+
+# pull alpine:edge to ./test from bfsu lxc mirror:
+rurima pull --mirror mirrors.bfsu.edu.cn/lxc-images alpine:edge ./test
+```
+# Utility commands:
+## Backup and restore
+```sh
+# backup container at ./alpine to ./alpine.tar:
+rurima backup -d ./alpine -f ./alpine.tar
+
+# restore alpine.tar to ./alpine:
+rurima restore -f ./alpine.tar -d ./alpine
+```
+## Other utility commands:
+```sh
+# update rurima:
+rurima ota
+
+# check for dependencies:
+rurima dep
+```
+# Call built-in ruri:
+ruri is a lightweight container runtime, it can be called directly by:
+```sh
+# Show ruri version info
+rurima r -v
+
+# Run container at ./alpine:
+rurima r ./alpine
+```
+# docker subcommand:
+The docker subcommand is an unofficial tool to get docker image from dockerhub.      
+## Full usage:
+```
+Usage: rurima docker [subcommand] [options]
+Subcommands:
+  search: Search images from DockerHub.
+  tag:    Search tags from DockerHub.
+  pull:   Pull image from DockerHub.
+  config: Get config of image from DockerHub.
+  arch:   Search architecture of image from DockerHub.
+  help:   Show help message.
+Options:
+  -i, --image: Image name.
+  -t, --tag: Tag of image.
+  -a, --arch: Architecture of image.
+  -s, --savedir: Save directory of image.
+  -p, --page_size: Page size of search.
+  -m, --mirror: Mirror of DockerHub.
+  -r, --runtime: runtime of container, support [ruri/proot/chroot].
+  -q, --quiet: Quiet mode.
+  -f, --fallback: Fallback mode.
+  -T, --try-mirrors <mirror>: Try mirrors.
+  -S, --start-at [num]: Start pulling layer at [num] when pulling image.
+  -n, --no-progress: Do not show progress.
+
+Note: please remove `https://` prefix from mirror url.
+For example: `-m registry-1.docker.io`
+You can add your perfered mirrors for `-T` option to try them first, for example: `-T hub.xdark.top -T dockerpull.org`
+```
+## Note:
+`-i` and `-t` is required options for `config` and `pull` subcommand.    
+`-i` is also used for `search` subcommand for image name.    
+# lxc subcommand:
+# Full usage:
+```
+Usage: rurima lxc [subcommand] [options]
+Subcommands:
+  pull: Pull image from LXC image server.
+  list: List images from LXC image server.
+  search: Search images from LXC image server.
+  arch: Search architecture of images from LXC image server.
+  help: Show help message.
+Options:
+  -m, --mirror: Mirror of LXC image server.
+  -o, --os: OS of image.
+  -v, --version: Version of image.
+  -a, --arch: Architecture of image.
+  -t, --type: Type of image.
+  -s, --savedir: Save directory of image.
+  -n, --no-progress: Do not show progress.
+
+Note: please remove `https://` prefix from mirror url.
+For example: `-m images.linuxcontainers.org`
+```
+# Note:
+`-o`, `-s` and `-v` is required options for `pull` subcommand.

src/include/version.h

@@ -29,5 +29,8 @@
  *
  */
 // Version info.
-#define RURIMA_VERSION "0.1-unreleased"
+#define RURIMA_VERSION "0.9"
+#define RURIMA_VERSION_MAJOR 0
+#define RURIMA_VERSION_MINOR 9
+#define RURIMA_VERSION_PATCH 0
 #include "../ruri/src/include/version.h"

src/info.c

@@ -43,8 +43,8 @@ void rurima_show_version_info(void)
 	cprintf("{base}      ●   ●  ●●●  ●   ●  ●●●  ●   ● ●   ●\n");
 	cprintf("{base}        Licensed under the MIT License\n");
 	cprintf("{base}          <https://mit-license.org>\n");
-	cprintf("{base}        Copyright (C) 2024 Moe-hacker\n\n");
-	cprintf("{base}%s%s%s", "rurima version ..................:  ", RURIMA_VERSION, "\n");
+	cprintf("{base}      Copyright (C) 2024-2025 Moe-hacker\n\n");
+	cprintf("{base}%s%d.%d.%d%s", "rurima version ..................:  ", RURIMA_VERSION_MAJOR, RURIMA_VERSION_MINOR, RURIMA_VERSION_PATCH, "\n");
 #if defined(RURIMA_COMMIT_ID)
 	cprintf("{base}%s%s%s", "rurima commit id ................:  ", RURIMA_COMMIT_ID, "\n");
 #endif
@@ -71,8 +71,8 @@ void rurima_show_version_code(void)
  * Maybe it can be useful one day...
  */
 #ifdef RURIMA_OFFICIAL_BUILD
-	cprintf("%s-official\n", RURIMA_VERSION);
+	cprintf("%d.%d.%d-official\n", RURIMA_VERSION_MAJOR, RURIMA_VERSION_MINOR, RURIMA_VERSION_PATCH);
 #else
-	cprintf("%s\n", RURIMA_VERSION);
+	cprintf("%d.%d.%d\n", RURIMA_VERSION_MAJOR, RURIMA_VERSION_MINOR, RURIMA_VERSION_PATCH);
 #endif
 }