Skip to content

mnutt/copilotkit-debugger

Repository files navigation

CopilotKit Debugger

UI widget that shows useful information about CopilotKit.

CopilotKit Debugger Screenshot

Functionality

Inspect:

  • messages sent and received
  • frontend actions registered
  • readable data registered not yet, dependent on CopilotKit/CopilotKit#1710

Usage

npm install copilotkit-debugger

Then, where you place your CopilotKit provider:

import { CopilotKit } from "@copilotkit/react-core";
import { CopilotContextDebugger } from "copilotkit-debugger";

import "copilotkit-debugger/styles.css";

const App = () => {
  return (
    <CopilotKit>
      {/* rest of app goes here */}
      <CopilotContextDebugger />
    </CopilotKit>
  )
}

Ensure you include the import for the debugger's styles.

License

The MIT License (MIT)

Copyright (c) Michael Nutt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published