Skip to content

UseVynix/vynix-sdk-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vynix JavaScript SDK

Vynix JavaScript SDK: a client for the Vynix bug reporting and website feedback API.

Website Docs License: MIT

Vynix JavaScript SDK is part of the Vynix developer toolkit. It helps JavaScript and TypeScript applications connect to the Vynix API for bug reports, website feedback, annotations, and developer context.

Vynix is built for teams that use AI coding agents. It captures visual feedback and debugging context so issues can move from a website to code faster.

What is Vynix?

Vynix is a website annotation and developer-context tool. Add a lightweight widget to a site, click the part of the page that is wrong, and Vynix captures useful context, including the selected element, a screenshot, console output, network activity, and an AI diagnosis of the likely root cause.

You can then copy a ready-to-build prompt or open a GitHub issue and assign it to a coding agent.

Learn more at vynix.in or read the documentation.

Why teams use Vynix

  • Click-to-annotate any page. Point at an element, a region, or selected text and leave a note pinned to the relevant place.
  • Automatic developer context. Each note can include the element selector, page URL, screenshot, and a privacy-safe capture of console errors and network calls.
  • AI root-cause diagnosis. Vynix uses the captured context to suggest the likely cause, a fix, and the files most likely involved.
  • Hand off to a coding agent. Convert a note into a clear prompt or GitHub issue, then assign it to Copilot or your own workflow.

Install

npm install @vynix/sdk

Note: the Vynix toolkit is rolling out. If a package or command above does not resolve yet, watch this repo for the release and use the hosted product at vynix.in in the meantime.

Usage

Create a client with your project key, then read or create annotations from JavaScript or TypeScript.

import { Vynix } from '@vynix/sdk';

const vynix = new Vynix({ projectKey: 'YOUR_PROJECT_KEY' });
const notes = await vynix.annotations.list();

Documentation

Full guides and the API reference are available at https://vynix.in/docs.

Related Vynix projects

Browse the full toolkit at the Vynix GitHub organisation.

Keywords

vynix, bug-reporting, visual-feedback, website-annotation, ai-diagnosis, developer-tools, feedback-tool, sdk, api-client, integration, javascript

About Vynix

Vynix is the feedback layer for teams building with AI coding agents. Point at a bug on any live website, and Vynix captures the context, diagnoses the likely cause, and hands it to your coding agent. Start free at vynix.in.

License

MIT, see LICENSE.

About

Vynix JavaScript SDK: a client for the Vynix bug reporting and website feedback API.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors