Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ariana) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Ariana is an IDE extension to understand what happens during runtime. You don't have to put print()
, console.log()
or breakpoints everywhere. Currently supports JS/TS & Python.
β¨ Key Features
Use Ariana VSCode extension to :
- π΅οΈ Inspect the last values taken by any expression in your code just by hovering it.
- β±οΈ See how long it took for any expression in your code to run.
- π§΅ Feed traces to Copilot/Cursor via MCP so they can know everything that happened when your code ran. (soon)
π How to use
1) πΎ Install the ariana
CLI
With npm:
npm install -g ariana
With pip:
pip install ariana
2) β¨ Run supported code as you would from the command line but with the ariana
command along side it
ariana <run command>
For example, on a JS/TS codebase it could be:
ariana npm run dev
... and on a Python codebase it could be:
ariana python myscript.py --some-options-maybe
3) π€ (Experimental) Ask for AI to recap what the code did and tell you if root causes of errors were identified
Whether you just want to know what your code did or want AI to figure out the root cause of some error that might have just crashed your program, run the following:
ariana --recap
Soon: prompt AI to look for specific information/answer specific questions
4) πΎ In your IDE, get instant debugging information in your code files.
You can install the extension on the VSCode Marketplace, or by searching for Ariana
in the extensions tab in VSCode or Cursor.
- Open a code file, press
ctrl + shift + p
and search for theAriana: Toggle Traced Expressions Highlighting
command. - πΊοΈ Know which code segments got ran and which didn't
- π΅οΈ Inspect the values that were taken by any expression in your code
Optional: If you just want to try out Ariana on example piece of code before using it on your own code, you can do this:
git clone https://github.com/dedale-dev/node-hello.git
cd node-hello
npm i
ariana npm run start
Troubleshooting / Help
π΅βπ« Ran into an issue? Need help? Shoot us an issue on GitHub or join our Discord community to get help!
Requirements
For JavaScript/TypeScript
- A JS/TS node.js/browser codebase with a
package.json
- The
ariana
command installed withnpm install -g ariana
(or any other installation method)
For Python
- Some Python
>= 3.9
code files (Notebooks not supported yet) - The
ariana
command installed withpip install ariana
outside of a virtual environment (or any other installation method)
Supported languages/tech
Language | Platform/Framework | Status |
---|---|---|
JavaScript/TypeScript | Node.js | β Supported |
Bun | β Supported | |
Deno | βοΈ Might work | |
Browser Frameworks | ||
JavaScript/TypeScript | React & .jsx / .tsx |
β Supported |
JQuery/Vanilla JS | β Supported | |
Vue/Svelte/Angular | β Only .js / .ts |
|
Other Languages | ||
Python | Scripts / Codebases | β Supported |
Jupyter Notebooks | β Not supported (yet) |
Code processing disclaimer
We need to process (but never store!) your JS/TS code files on our server based in EU in order to have Ariana work with it. It is not sent to any third-party including any LLM provider. An enterprise plan will come later with enterprise-grade security and compliance. If that is important to you, please let us know.
Licence
Ariana is released under AGPLv3. See LICENCE.txt for more details.
tl;dr: If you use Ariana as intended, which means in development, this is nothing to worry about as you don't technically bundle Ariana with your released code. If you use it in your production code, whether deployed on a server or on the end-user's machine in a code or binary format, your code needs to be available to the public under the same licence. We can lift that requirement upon request, even for free if your project is small. Please let us know.