Skip to content

Commit 2b4396e

Browse files
committed
Add outputs for command line utilities
1 parent 1540d9a commit 2b4396e

1 file changed

Lines changed: 106 additions & 10 deletions

File tree

README.md

Lines changed: 106 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -146,27 +146,123 @@ cat2-admin adduser user@example.com foobar11
146146

147147
### Command-line client
148148

149-
**List roots:**
149+
**List available roots:**
150150
```sh
151-
cat2-client --user user@example.com --pass foobar11 roots
152-
# Output: @public, @personal, @shared
151+
cat2-client roots
153152
```
153+
<details>
154+
<summary>Show output</summary>
154155

155-
**Upload a dataset:**
156-
```sh
157-
cat2-client --user user@example.com --pass foobar11 upload root-example/ds-1d.b2nd @personal/ds-1d.b2nd
158156
```
157+
@public
158+
```
159+
</details>
159160

160-
**Get dataset info:**
161+
**List datasets:**
161162
```sh
162-
cat2-client --user user@example.com --pass foobar11 info @personal/ds-1d.b2nd
163-
# Returns: shape, chunks, dtype, compression params, etc.
163+
cat2-client list @public
164+
```
165+
<details>
166+
<summary>Show output</summary>
167+
168+
```
169+
examples/README.md
170+
examples/Wutujing-River.jpg
171+
examples/cat2cloud-brochure.pdf
172+
examples/cube-1k-1k-1k.b2nd
173+
examples/cubeA.b2nd
174+
examples/cubeB.b2nd
175+
examples/dir1/ds-2d.b2nd
176+
examples/dir1/ds-3d.b2nd
177+
examples/dir2/ds-4d.b2nd
178+
examples/ds-1d-b.b2nd
179+
examples/ds-1d-fields.b2nd
180+
examples/ds-1d.b2nd
181+
examples/ds-2d-fields.b2nd
182+
examples/ds-hello.b2frame
183+
examples/ds-sc-attr.b2nd
184+
examples/gaia-ly.b2nd
185+
examples/hdf5root-example.h5
186+
examples/ironpill_nb.ipynb
187+
examples/kevlar-tomo.b2nd
188+
examples/lazyarray-large.png
189+
examples/lung-jpeg2000_10x.b2nd
190+
examples/numbers_color.b2nd
191+
examples/numbers_gray.b2nd
192+
examples/sa-1M.b2nd
193+
examples/slice-time.ipynb
194+
examples/tomo-guess-test.b2nd
195+
large/gaia-3d.b2nd
196+
large/slice-gaia-3d.ipynb
164197
```
198+
</details>
165199

166200
**Browse directory tree:**
167201
```sh
168-
cat2-client --user user@example.com --pass foobar11 tree @public
202+
cat2-client tree @public
203+
```
204+
<details>
205+
<summary>Show output</summary>
206+
207+
```
208+
├── examples
209+
│ ├── README.md
210+
│ ├── Wutujing-River.jpg
211+
│ ├── cat2cloud-brochure.pdf
212+
│ ├── cube-1k-1k-1k.b2nd
213+
│ ├── cubeA.b2nd
214+
│ ├── cubeB.b2nd
215+
│ ├── dir1
216+
│ │ ├── ds-2d.b2nd
217+
│ │ └── ds-3d.b2nd
218+
│ ├── dir2
219+
│ │ └── ds-4d.b2nd
220+
│ ├── ds-1d-b.b2nd
221+
│ ├── ds-1d-fields.b2nd
222+
│ ├── ds-1d.b2nd
223+
│ ├── ds-2d-fields.b2nd
224+
│ ├── ds-hello.b2frame
225+
│ ├── ds-sc-attr.b2nd
226+
│ ├── gaia-ly.b2nd
227+
│ ├── hdf5root-example.h5
228+
│ ├── ironpill_nb.ipynb
229+
│ ├── kevlar-tomo.b2nd
230+
│ ├── lazyarray-large.png
231+
│ ├── lung-jpeg2000_10x.b2nd
232+
│ ├── numbers_color.b2nd
233+
│ ├── numbers_gray.b2nd
234+
│ ├── sa-1M.b2nd
235+
│ ├── slice-time.ipynb
236+
│ └── tomo-guess-test.b2nd
237+
└── large
238+
├── gaia-3d.b2nd
239+
└── slice-gaia-3d.ipynb
240+
```
241+
</details>
242+
243+
**Get dataset info:**
244+
```sh
245+
cat2-client info @public/examples/ds-1d.b2nd
246+
```
247+
<details>
248+
<summary>Show output</summary>
249+
250+
```
251+
Getting info for @public/examples/ds-1d.b2nd
252+
shape : [1000]
253+
chunks: [100]
254+
blocks: [10]
255+
dtype : int64
256+
nbytes: 7.81 KiB
257+
cbytes: 4.90 KiB
258+
ratio : 1.59x
259+
mtime : 2026-01-15T17:04:50.823466Z
260+
cparams:
261+
codec : ZSTD (5)
262+
clevel : 1
263+
filters: [SHUFFLE]
169264
```
265+
</details>
170266

171267
For more commands: `cat2-client --help`
172268

0 commit comments

Comments
 (0)