docsgpt

v0.4.2

DocsGPT 🦖 is an innovative open-source tool designed to simplify the retrieval of information from project documentation using advanced GPT models 🤖. For more information about how to use this package see README

Latest version published 17 days ago

License: MIT

NPM

GitHub

Package Health Score

90 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.4.2	\|	09/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.9	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.4	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.9	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (136)

GitHub Stars: 14.59K
Forks: 1.47K
Contributors: 150

Direct Usage Popularity

The npm package docsgpt receives a total of 136 downloads a week. As such, we scored docsgpt popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package docsgpt, we found that it has been starred 14,588 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for docsgpt project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 38
Open PR: 15
Last Release: 17 days ago
Last Commit: 6 days ago

Further analysis of the maintenance status of docsgpt based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that docsgpt demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 17 Direct
Versions: 29
Install Size: 8.61 MB
Dist-tags: 1
# of Files: 12
Maintainers: 3
TS Typings: No

docsgpt has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

DocsGPT react widget

This widget will allow you to embed a DocsGPT assistant in your React app.

Installation

npm install  docsgpt

Usage

React

    import { DocsGPTWidget } from "docsgpt";

    const App = () =&gt; {
      return ;
    };

To link the widget to your api and your documents you can pass parameters to the component.

    import { DocsGPTWidget } from "docsgpt";

    const App = () =&gt; {
      return ;
    };

Html

    
    
      
        
        
        
        <title>DocsGPT Widget</title>
      
      
        <div id="app"></div>

To link the widget to your api and your documents you can pass parameters to the renderDocsGPTWidget('div id', { parameters }).

    
    
      
        
        
        
        <title>DocsGPT Widget</title>
      
      
        <div id="app"></div>

Our github

DocsGPT

You can find the source code in the extensions/react-widget folder.

docsgpt dependencies

@babel/plugin-transform-flow-strip-types @parcel/resolver-glob @parcel/transformer-svg-react @parcel/transformer-typescript-tsc @parcel/validator-typescript @radix-ui/react-icons class-variance-authority clsx dompurify flow-bin i install markdown-it npm react react-dom styled-components

docsgpt development dependencies

@babel/core @babel/preset-env @babel/preset-react @parcel/packager-ts @parcel/transformer-typescript-types @types/dompurify @types/markdown-it @types/react @types/react-dom babel-loader parcel process typescript

FAQs

What is docsgpt?

DocsGPT 🦖 is an innovative open-source tool designed to simplify the retrieval of information from project documentati... Visit Snyk Advisor to see a full health score report for docsgpt, including popularity, security, maintenance & community analysis.

Is docsgpt popular?

The npm package docsgpt receives a total of 136 weekly downloads. As such, docsgpt popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is docsgpt well maintained?

We found that docsgpt demonstrated a healthy version release cadence and project activity. It has a community of 150 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is docsgpt safe to use?

The npm package docsgpt was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 September-2024, at 09:35 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP