CLIPPIUM

Appearance

LLM Resources

clippium-toolkit ​

ToolKit for working with clippium CLIs

Setup ​

Execute:

bash
npx clippium-toolkit
bash
pnpx install clippium-toolkit
bash
yarn dlx clippium-toolkit
bash
bunx clippium-toolkit
bash
deno run -A npm:clippium-toolkit

Install:

bash
npm install clippium-toolkit
bash
pnpm install clippium-toolkit
bash
yarn add clippium-toolkit
bash
bun add clippium-toolkit
bash
deno add clippium-toolkit

docs command ​

Create documentation for your Clippium command instantly.

js
// src/clippium-data.ts
import { defineData } from 'clippium'

export default defineData( {
	// your data
})
bash
clippium-toolkit docs -i src/clippium-data.ts -o docs/cli-api.md
# or
clippium-toolkit docs -i src/clippium-data.ts > docs/cli-api.md

convert command ​

Convert to and from Clippium CLI data

js
// src/clippium-data.ts
import { defineData } from 'clippium'

export default defineData( {
	// your data
})

From data ​

Examples:

Convert a clippium data to json schema ​

bash
clippium-toolkit convert schema from-data -i src/clippium-data.ts -o dist/schema.json

to data ​

Examples:

Convert a json schema to clippium data ​

bash
clippium-toolkit convert schema to-data -i src/schema.json -o src/clippium-data.ts

Convert a openapi schema to clippium data ​

bash
clippium-toolkit convert openapi to-data -i https://petstore.swagger.io/v2/swagger.json -o ./src/data.js

Convert a typescript type to clippium data ​

bash
clippium-toolkit convert type to-data -i ./my-type.ts -o ./clippium-data.ts --type MyType

Convert a ESM (JS/TS) function to clippium data ​

bash
clippium-toolkit convert esm to-data -i ./src/index.js -o ./clippium-data.ts
## or specify function exported
clippium-toolkit convert esm to-data -i /src/index.js -o ./clippium-data.ts --export add

create command ​

bash
clippium-toolkit create

Plugins ​

Plugins are a way to extend the functionality of clippium-toolkit

Read API documentation for more information. Read more

Add plugin ​

js
import myplugin from './my-plugin'

/**
 * @type {import('clippium-toolkit').Config}
 */
export default {
	plugins: {
		myPlugin: myplugin()
	}
}

or:

js
import { defineConfig } from 'clippium-toolkit'
import myplugin from './my-plugin'

export default defineConfig( {
	plugins: {
		myPlugin: myplugin()
	}
})

Create a plugin ​

js
import { createPlugin } from 'clippium-toolkit'

export default createPlugin( {
	desc: 'My Plugin description',
	// Add documentation command
	docs : {
		fn : async data => {
			// your code
			return ''
		}
	}
	// Add convert commands
	convert : {
		// your convert functions
	}
})

Other uses ​

Run cli as a library ​

js
import { run } from 'clippium-toolkit'

run( process.argv.slice( 2 ) )

Run functions ​

js
import { Converter } from 'clippium-toolkit'

const converter = new Converter( {
	// your data
} )

await converter.toData( ... )

➕ More ​