JavaScript SDK

Installing datasherlock

You can install datasherlock in your React project with

npm install datasherlock

Using datasherlock-components in your project

You can import our Sherlock component in your React project, using the code below.

import { useState } from "react";
import "./App.css";
import DatasherlockAgent from "datasherlock";
import "../datasherlock/dist/style.css";

function App() {
  return (
        display: "flex",
        flexDirection: "row",
        justifyItems: "center",
        justifyContent: "center",
      <div style={{ width: "100%" }}>
          buttonText={"Ask Sherlock"}

export default App;


  • agentID : Your Agent ID

  • apiKey : Your Agent API Key

  • debugMode : If this is true, the SQL query used to get the result will be shown. If it is false, only the data will be shown and the data will be hidden

  • sqlOnly : If this is true, only the SQL query will be shown and the data will be hidden

  • loadingMessage : This is the message that comes up while a user is waiting for the results to appear

  • color : Select your preferred color from the options provided: red, blue, green, or orange. Leave the field empty for the default color.

  • theme : Choose between a light or dark theme, or opt for the system theme.

Last updated