neo4j-cli 0.1.0a5__py3-none-win_amd64.whl

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.
neo4j_cli/__init__.py ADDED
@@ -0,0 +1,2 @@
1
+ # neo4j-cli — generated shim package
2
+ __version__ = "0.1.0a5"
neo4j_cli/_shim.py ADDED
@@ -0,0 +1,6 @@
1
+ import os, sys, subprocess
2
+
3
+ def main():
4
+ here = os.path.dirname(os.path.abspath(__file__))
5
+ binary = os.path.join(here, "neo4j-cli.exe")
6
+ sys.exit(subprocess.call([binary] + sys.argv[1:]))
Binary file
@@ -0,0 +1,179 @@
1
+ Metadata-Version: 2.4
2
+ Name: neo4j-cli
3
+ Version: 0.1.0a5
4
+ Summary: neo4j-cli — packaged as a Python wheel
5
+ Project-URL: Source, https://github.com/neo4j-labs/neo4j-cli
6
+ Classifier: Programming Language :: Python :: 3
7
+ License-Expression: MIT
8
+ License-File: LICENSE.txt
9
+ Requires-Python: >=3.9
10
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
11
+
12
+ # Neo4j CLI ALPHA
13
+
14
+
15
+ > __This is an alpha release and is not suitable for production environments__
16
+
17
+ Neo4j CLI is a CLI that can be used by people and *AI Agents* to interact with a range of Neo4j capabilities. Initially this is with Aura and executing Cypher against graph database. More is to come with each evolution of the CLI.
18
+
19
+ As `neo4j-cli` is a labs project and is currently at Alpha stage of development, be aware that:
20
+
21
+ - It is not supported.
22
+ - It may contain breaking changes between its own releases and with the official Neo4j MCP server.
23
+ - It should be tested before using.
24
+ - __DO NOT USE WITH PRODUCTION ENVIRONMENTS__
25
+
26
+ ## Installation
27
+
28
+ ### pip
29
+ `pip install neo4j-cli`
30
+
31
+ ### pipx
32
+ `pipx install neo4j-cli`
33
+
34
+ ### uv
35
+ `uv tool install neo4j-cli`
36
+
37
+ ###uvx
38
+ Downloads and executes neo4j-cli. You will need to include args for whatever you want to do as part of the command
39
+
40
+ `uvx -i neo4j-cli YOUR_ARGS_HERE`
41
+
42
+
43
+ ### Verify the installation:
44
+ `neo4j-cli -v`
45
+
46
+ Should print the installed version.
47
+
48
+
49
+ ## Usage
50
+ Create Aura API Credentials in your [Account Settings](https://console.neo4j.io/#account), and note down the client ID and secret.
51
+
52
+ Add these credentials into the CLI with a name of your choosing:
53
+
54
+ ```bash
55
+ ./neo4j-cli aura credential add --name "Aura API Credentials" --client-id <client-id> --client-secret <client-secret>
56
+ ```
57
+
58
+ This will add and set the credential as the default credential for use.
59
+
60
+ You can then, for example, list your instances in a table format:
61
+
62
+ ```bash
63
+ ./neo4j-cli aura instance list --format table
64
+ ```
65
+
66
+ If you would rather just type `neo4j-cli` then move the neo4j-cli binary into the file path of your computer.
67
+ Windows:
68
+
69
+ ```bash
70
+ move neo4j-cli.exe c:\windows\system32
71
+ ```
72
+
73
+ Mac:
74
+
75
+ ```bash
76
+ sudo mv neo4j-cli /usr/local/bin
77
+ ```
78
+
79
+ To see all of the available commands:
80
+
81
+ ```bash
82
+ ./neo4j-cli
83
+ ```
84
+
85
+ Help for each command is accessed by using it without any flags or options. For example, to see help creating an instance:
86
+
87
+ ```bash
88
+ ./neo4j-cli aura instance create
89
+ ```
90
+
91
+ ## Querying Neo4j
92
+
93
+ `neo4j-cli query` runs Cypher against any Neo4j database via the HTTP Query API. Cypher comes from the positional argument or piped stdin.
94
+
95
+ ```bash
96
+ ./neo4j-cli query 'RETURN 1 AS n'
97
+ echo 'MATCH (n) RETURN count(n)' | ./neo4j-cli query
98
+ ```
99
+
100
+ Connection settings are resolved with this precedence (highest first): flag → env var → `.env` file (auto-discovered by walking up from cwd) → built-in default.
101
+
102
+ | Setting | Flag | Env var | Default |
103
+ | -------- | ------------ | ---------------- | ----------------------- |
104
+ | URI | `--uri` | `NEO4J_URI` | `http://localhost:7474` |
105
+ | Username | `--username` | `NEO4J_USERNAME` | `neo4j` |
106
+ | Password | `--password` | `NEO4J_PASSWORD` | prompted on TTY |
107
+ | Database | `--database` | `NEO4J_DATABASE` | `neo4j` |
108
+
109
+ Bolt-family URIs (`bolt://`, `neo4j://`, `neo4j+s://`, …) are auto-rewritten to `http(s)://` and Aura hosts (`*.neo4j.io`) are forced to `https://<host>:443`.
110
+
111
+ Pass parameters with `--param key=value` (repeatable). Values that parse as JSON are typed; everything else is a string:
112
+
113
+ ```bash
114
+ ./neo4j-cli query 'MATCH (p:Person {name:$name}) RETURN p' --param name=Alice
115
+ ./neo4j-cli query 'RETURN $ids' --param 'ids=[1,2,3]'
116
+ echo 'MATCH (p:Person {name:$name}) RETURN p' | ./neo4j-cli query --param name=Alice
117
+ ```
118
+
119
+ Output is a table by default; pass `--format json` for a stable envelope (`columns`, `rows`, `truncated`, `arrays_truncated`). When stdout is not a terminal (piped or redirected), `--format` defaults to `json`. Applies to both `query` and `:schema`. Large results are capped at 100 rows and arrays inside cells at 100 items — tune with `--max-rows` / `--truncate-arrays-over` (0 = unlimited).
120
+
121
+ Schema introspection:
122
+
123
+ ```bash
124
+ ./neo4j-cli query :schema
125
+ ```
126
+
127
+ Use `--insecure` to skip TLS verification for self-signed dev setups.
128
+
129
+ ## Agent skills
130
+
131
+ `neo4j-cli` ships an embedded skill bundle (`SKILL.md` + per-subcommand references) that teaches AI coding agents how to drive the CLI. `skill install` drops that bundle into the supported agents' skill directories so the agent picks it up on next run.
132
+
133
+ Supported agents:
134
+
135
+ - Claude Code
136
+ - Cursor
137
+ - Windsurf
138
+ - Copilot
139
+ - Gemini CLI
140
+ - Cline
141
+ - Codex
142
+ - Pi
143
+ - OpenCode
144
+ - Junie
145
+
146
+ Install into every detected agent (or pass an agent name to target one):
147
+
148
+ ```bash
149
+ ./neo4j-cli skill install
150
+ ./neo4j-cli skill install claude-code
151
+ ```
152
+
153
+ List supported agents and per-agent install state:
154
+
155
+ ```bash
156
+ ./neo4j-cli skill list
157
+ ```
158
+
159
+ Check installed bundles for version drift against the running binary:
160
+
161
+ ```bash
162
+ ./neo4j-cli skill check
163
+ ```
164
+
165
+ Remove the installed bundle (idempotent):
166
+
167
+ ```bash
168
+ ./neo4j-cli skill remove
169
+ ./neo4j-cli skill remove claude-code
170
+ ```
171
+
172
+ The same `skill` subcommand is available on `aura-cli`, scoped to the standalone Aura surface.
173
+
174
+ Beta features (commands gated by `AuraBetaEnabled`, e.g. `dataapi`, `import`, `deployment`) are not included in the generated bundle — the bundle reflects the default-config command surface.
175
+
176
+ ## Feedback / Issues
177
+
178
+ Please use [GitHub issues](https://github.com/neo4j-labs/neo4j-cli/issues) to provide feedback and report any issues that you have encountered.
179
+
@@ -0,0 +1,8 @@
1
+ neo4j_cli/neo4j-cli.exe,sha256=oioS_veUM2XkLChxTpvozE7rMHzomhPkMLy0S3WJsxA,13385728
2
+ neo4j_cli/__init__.py,sha256=WhzDMKxUfJ3oltF0SslpfYsjblcPew0g6kDE-p8Yh6Y,63
3
+ neo4j_cli/_shim.py,sha256=lw-321sXsnwMX8XtG7djEDUYMbuf8AqO8ZZtpBP1ICs,198
4
+ neo4j_cli-0.1.0a5.dist-info/METADATA,sha256=7dVHs7I4novilEw-ydd9yPz878NH1sjgCdoFANY8_3w,5593
5
+ neo4j_cli-0.1.0a5.dist-info/WHEEL,sha256=uhcCZnjczy53ZMJlW1NBA6E4ItAVd3ekDDVYAiQUqxw,89
6
+ neo4j_cli-0.1.0a5.dist-info/entry_points.txt,sha256=SJSAj75bbbk_6BEt6WSqBiattSNVuEZpRKOHSTMHK5Y,51
7
+ neo4j_cli-0.1.0a5.dist-info/licenses/LICENSE.txt,sha256=7YbhySCfx9aIKOa-NbheGCx367BEagB8B8r0X0IGuo0,11342
8
+ neo4j_cli-0.1.0a5.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: buildwheels
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-win_amd64
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ neo4j-cli = neo4j_cli._shim:main
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ https://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2022 Neo4j Inc.
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ https://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.