@coreviz/cli 1.0.10 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -23
- package/package.json +1 -1
- package/screenshots/banner.png +0 -0
- package/screenshots/cli-demo.gif +0 -0
- package/screenshots/demo.gif +0 -0
- package/examples/bulk_edit_with_nanobanana/edited-1764197873666-62cc0c0ab7208b594ba989daa450cf54263667fc-3718x2400.jpg +0 -0
- package/examples/bulk_edit_with_nanobanana/edited-1764197885861-DSC_0359.jpg +0 -0
- package/examples/bulk_edit_with_nanobanana/edited-1764197898854-Elfreth's_Alley.jpeg +0 -0
package/README.md
CHANGED
|
@@ -1,5 +1,39 @@
|
|
|
1
|
+
[](https://coreviz.io)
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<h1>CoreViz</h1>
|
|
5
|
+
<a href="https://coreviz.io/">Home</a>
|
|
6
|
+
<span> • </span>
|
|
7
|
+
<a href="https://lab.coreviz.io/">Studio</a>
|
|
8
|
+
<span> • </span>
|
|
9
|
+
<a href="https://github.com/coreviz/cli">CLI</a>
|
|
10
|
+
<span> • </span>
|
|
11
|
+
<a href="https://github.com/coreviz/sdk">SDK</a>
|
|
12
|
+
<span> • </span>
|
|
13
|
+
<a href="https://docs.coreviz.io/">Docs</a>
|
|
14
|
+
<span> • </span>
|
|
15
|
+
<a href="https://x.com/withcoreviz">X</a>
|
|
16
|
+
<span> • </span>
|
|
17
|
+
<a href="https://www.linkedin.com/company/coreviz/">LinkedIn</a>
|
|
18
|
+
<span> • </span>
|
|
19
|
+
<a href="mailto:team@coreviz.io">Contact</a>
|
|
20
|
+
<br />
|
|
21
|
+
<br />
|
|
22
|
+
|
|
23
|
+
CoreViz is a Vision AI platform for teams and individuals working with thousands of visual assets.
|
|
24
|
+
|
|
25
|
+
<p align="center">
|
|
26
|
+
<a href="https://coreviz.io"><img alt="CoreViz" src="./screenshots/demo.gif"></a>
|
|
27
|
+
</p>
|
|
28
|
+
</div>
|
|
29
|
+
|
|
30
|
+
|
|
1
31
|
# @coreviz/cli
|
|
2
32
|
|
|
33
|
+
<p align="center">
|
|
34
|
+
<a href="https://coreviz.io"><img alt="CoreViz" src="./screenshots/cli-demo.gif"></a>
|
|
35
|
+
</p>
|
|
36
|
+
|
|
3
37
|
An AI-powered CLI for working with photos. Semantically search, edit, tag and generate metadata for thousands of photos right from the command line.
|
|
4
38
|
|
|
5
39
|
## Installation
|
|
@@ -19,57 +53,90 @@ coreviz [command]
|
|
|
19
53
|
```
|
|
20
54
|
|
|
21
55
|
## Commands
|
|
56
|
+
### AI Features
|
|
22
57
|
|
|
23
|
-
|
|
58
|
+
Describe an image:
|
|
24
59
|
|
|
25
|
-
|
|
60
|
+
```bash
|
|
61
|
+
npx @coreviz/cli describe path/to/image.jpg
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+

|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
Edit an image with a text prompt (🍌 Nano Banan + Flux Kontext in the CLI!):
|
|
26
69
|
|
|
27
70
|
```bash
|
|
28
|
-
npx @coreviz/cli
|
|
71
|
+
npx @coreviz/cli edit path/to/image.jpg --prompt "make it cyberpunk style"
|
|
29
72
|
```
|
|
30
73
|
|
|
31
|
-
|
|
74
|
+

|
|
75
|
+
|
|
76
|
+
Generate tags or classify an image:
|
|
32
77
|
|
|
33
78
|
```bash
|
|
34
|
-
npx @coreviz/cli
|
|
79
|
+
npx @coreviz/cli tag path/to/image.jpg "objects in the image"
|
|
35
80
|
```
|
|
36
81
|
|
|
37
|
-
|
|
82
|
+
Classify an image using specific choices:
|
|
38
83
|
|
|
39
84
|
```bash
|
|
40
|
-
npx @coreviz/cli
|
|
85
|
+
npx @coreviz/cli tag path/to/image.jpg --choices "receipt,invoice,document" --single
|
|
41
86
|
```
|
|
42
87
|
|
|
43
|
-
|
|
88
|
+
Run tagging locally (offline capable):
|
|
44
89
|
|
|
45
|
-
|
|
90
|
+
```bash
|
|
91
|
+
npx @coreviz/cli tag path/to/image.jpg "prompt" --mode local
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Search local images using natural language:
|
|
46
95
|
|
|
47
96
|
```bash
|
|
48
|
-
npx @coreviz/cli
|
|
97
|
+
npx @coreviz/cli search "a person wearing a red t-shirt"
|
|
49
98
|
```
|
|
50
99
|
|
|
51
|
-

|
|
52
101
|
|
|
53
102
|
|
|
103
|
+
This will index the images in your current directory (creating a `.index.db` file) and return the top matches for your query.
|
|
54
104
|
|
|
55
|
-
|
|
105
|
+
You can also use the cloud API for embeddings:
|
|
56
106
|
|
|
57
107
|
```bash
|
|
58
|
-
npx @coreviz/cli
|
|
108
|
+
npx @coreviz/cli search "query" --mode api
|
|
59
109
|
```
|
|
60
110
|
|
|
61
|
-

|
|
62
111
|
|
|
63
|
-
|
|
112
|
+
### Scripting
|
|
113
|
+
|
|
114
|
+
All commands support a `--quiet` flag to suppress UI output and return only raw results.
|
|
64
115
|
|
|
65
116
|
```bash
|
|
66
|
-
|
|
117
|
+
# Returns only the file path of the edited image
|
|
118
|
+
npx @coreviz/cli edit image.jpg "prompt" --quiet
|
|
67
119
|
```
|
|
68
120
|
|
|
69
|
-
|
|
121
|
+
### Authentication
|
|
70
122
|
|
|
123
|
+
Login to CoreViz using device authorization:
|
|
71
124
|
|
|
72
|
-
|
|
125
|
+
```bash
|
|
126
|
+
npx @coreviz/cli login
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Logout:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
npx @coreviz/cli logout
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Check login status:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
npx @coreviz/cli whoami
|
|
139
|
+
```
|
|
73
140
|
|
|
74
141
|
## Development
|
|
75
142
|
|
|
@@ -82,8 +149,4 @@ This will index the images in your current directory (creating a `.index.db` fil
|
|
|
82
149
|
2. Run local CLI:
|
|
83
150
|
```bash
|
|
84
151
|
node bin/cli.js --help
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## License
|
|
88
|
-
|
|
89
|
-
MIT
|
|
152
|
+
```
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|