shazhou/ocas
8
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix store path and remove redundant alias text

Browse Source 
- README.md: ~/.uncaged/ocas → ~/.ocas
- CLI README: remove '(also aliased ocas)' redundancy

Thanks 小墨 for the review 🖊️

Closes #8
This commit is contained in:
小橘
2026-06-01 06:29:59 +00:00
parent 119e65c096
commit 4b114e96ac
3 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LICENSE
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Scott Wei
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
README.md
+2 -2
View File
@@ -89,7 +89,7 @@ Or use the CLI (see [CLI Reference](#cli-reference) and [`packages/cli-ocas/READ
## CLI Reference ## CLI Reference
Binary: `ocas` (from `@ocas/cli`; legacy alias `ocas` is deprecated). Default store: Binary: `ocas` (from `@ocas/cli`; legacy alias `ocas` is deprecated). Default store:
`~/.uncaged/ocas`. The store is auto-created and bootstrapped on first use — there is `~/.ocas`. The store is auto-created and bootstrapped on first use — there is
no `init`/`bootstrap` command, and schemas are ordinary `@schema`-typed nodes (`ocas put no `init`/`bootstrap` command, and schemas are ordinary `@schema`-typed nodes (`ocas put
@schema file.json`), so there is no `schema` subcommand. @schema file.json`), so there is no `schema` subcommand.
@@ -127,7 +127,7 @@ Commands (all emit a { type, value } envelope unless noted):
gc Garbage collection (@output/gc) gc Garbage collection (@output/gc)
Flags: Flags:
--store <path> Store directory (default: ~/.uncaged/ocas) --store <path> Store directory (default: ~/.ocas)
--json Compact JSON output --json Compact JSON output
--pipe, -p Read a { type, value } envelope from stdin for render --pipe, -p Read a { type, value } envelope from stdin for render
``` ```
packages/cli/README.md
+1 -1
View File
@@ -4,7 +4,7 @@ CLI tool for ocas stores.
## Overview ## Overview
`@ocas/cli` provides the `ocas` command (also aliased `ocas`) for managing a filesystem-backed store: node CRUD, integrity checks, reference listing, graph walks, variables, and output templates. It uses `@ocas/fs` for persistence and `@ocas/core` for core operations. `@ocas/cli` provides the `ocas` command for managing a filesystem-backed store: node CRUD, integrity checks, reference listing, graph walks, variables, and output templates. It uses `@ocas/fs` for persistence and `@ocas/core` for core operations.
The store is **auto-created and bootstrapped** on first use, so there is no `init`/`bootstrap` command. Schemas are ordinary `@schema`-typed nodes — register one with `ocas put @schema file.json` and list them with `ocas list --type @schema`; there is no dedicated `schema` subcommand. The store is **auto-created and bootstrapped** on first use, so there is no `init`/`bootstrap` command. Schemas are ordinary `@schema`-typed nodes — register one with `ocas put @schema file.json` and list them with `ocas list --type @schema`; there is no dedicated `schema` subcommand.