@toolforge-js/sdk 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,79 @@
+# Tool Forge SDK
+
+Backend code to complete tools, instantly.
+
+Tool Forge SDK provides the necessary backend functionalities to build and run tools seamlessly. It abstracts away the complexities of backend development, allowing developers to focus on writing code while Tool Forge SDK handles the rest.
+
+## Installation
+
+### Prerequisites
+
+- tool-forge sdk uses [bun](https://bun.sh) runtime, so you need to install `bun`
+
+### Installation Steps
+
+You can install the tool-forge sdk package using `bun` by running the following command in your terminal:
+
+```sh
+bun add @toolforge-js/sdk
+```
+
+This command will add the tool-forge sdk package to your project's dependencies, allowing you to utilize its features in your backend development.
+
+### Getting Authentication Credentials
+
+To use tool-forge sdk, you need to obtain authentication credentials. Follow these steps:
+
+1. Sign up or log in to your Tool Forge account.
+2. Create a new workspace or select an existing one.
+3. Create a new environment within the workspace or select an existing one.
+4. Generate a new API key for that environment.
+5. Store these credentials securely, as you will need them to authenticate your requests when using the SDK.
+
+## Usage
+
+### Setting Up the SDK
+
+After installing the tool-forge sdk, you have configure the SDK using `toolforge.config.ts`
+
+```ts
+// toolforge.config.ts
+import { defineToolForgeConfig } from '@toolforge-js/sdk'
+import 'dotenv/config'
+import { defineConfig } from '@toolforge-js/sdk/config'
+import * as z from 'zod'
+
+// store the API key in environment variable TOOL_FORGE_API_KEY
+
+const { TOOL_FORGE_API_KEY } = z
+  .object({
+    TOOL_FORGE_API_KEY: z
+      .string()
+      .refine((val) => val.startsWith('sk_live') || val.startsWith('pk_test'), {
+        message: 'API key must start with sk_live or pk_test',
+      }),
+  })
+  .parse(process.env)
+
+export default defineConfig({
+  apiKey: TOOL_FORGE_API_KEY,
+})
+```
+
+### Writing a Tool
+
+After installing the tool-forge sdk package, you can start using it in your backend code. Here's a simple example to get you started:
+
+```ts
+// tools/my-first-tool.ts
+import { defineTool } from '@toolforge-js/sdk'
+
+export default defineTool({
+  name: 'My First Tool',
+  description: 'A simple tool using Tool Forge SDK',
+  async run({ io }) {
+    const name = await io.textInput({ label: 'Enter your name' })
+    return `Hello, ${name}!`
+  },
+})
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolforge-js/sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     "./components": {
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@toolforge-js/config": "workspace:*",
-    "@types/bun": "1.2.8",
+    "@types/bun": "1.3.1",
     "@types/node": "24.0.7",
     "commander": "14.0.1",
     "eslint": "9.24.0",