move cli to bin/

Author: severo

README.md

@@ -1,9 +1,72 @@
-# React components for hyparam apps
+# hyperparam
 
-This package contains the React components for the hyparam apps.
+[![npm](https://img.shields.io/npm/v/hyperparam)](https://www.npmjs.com/package/hyperparam)
+[![workflow status](https://github.com/hyparam/hyperparam-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/hyparam/hyperparam-cli/actions)
+[![mit license](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+![coverage](https://img.shields.io/badge/Coverage-35-darkred)
 
-It depends on [hyparquet](https://github.com/hyparam/hyparquet), [hyparquet-compressors](https://github.com/hyparam/hyparquet-compressors), [hightable](https://github.com/hyparam/hightable/), and requires React to be installed (peer-dependency).
+This is the hyperparam cli tool.
 
-It is used in [hyperparam](https://github.com/hyparam/hyperparam-cli/tree/master/packages/cli).
+The hyperparam cli tool is for viewing arbitrarily large datasets in the browser.
 
-It also contains utilities, in the lib/ subdirectory, that can be used without React. They are used in [hyparquet-demo](https://github.com/hyparam/hyperparam-cli/tree/master/apps/hyparquet-demo).
+## Viewer
+
+To open a file browser in your current local directory run:
+
+```sh
+npx hyperparam
+```
+
+You can also pass a specific file, folder, or url:
+
+```sh
+npx hyperparam example.parquet
+npx hyperparam directory/
+npx hyperparam https://hyperparam-public.s3.amazonaws.com/bunnies.parquet
+```
+
+## Chat
+
+To start a chat with hyperparam:
+
+```sh
+npx hyperparam chat
+```
+
+## Installation
+
+Install for all users:
+
+```sh
+sudo npm i -g hyperparam
+```
+
+Now you can just run:
+
+```sh
+hyperparam
+```
+
+or:
+
+```sh
+hyp
+```
+
+## Developers
+
+To develop the CLI locally:
+
+```sh
+npm i
+npm run build
+npm run serve
+```
+
+When you make changes, make sure to rebuild:
+
+```sh
+npm run build
+```
+
+Then refresh the browser.

packages/cli/src/chat.js bin/chat.jspackages/cli/src/chat.js renamed to bin/chat.js

@@ -80,17 +80,20 @@ function handleRequest(req, serveDirectory) {
   // get location of hyperparam assets
   const hyperparamPath = decodeURIComponent(import.meta.url)
     .replace('file://', '')
-    .replace('/src/serve.js', '')
+    .replace('/bin/serve.js', '')
 
   if (pathname === '/' || pathname === '/files/') {
     // redirect to /files
     return { status: 301, content: '/files' }
   } else if (pathname.startsWith('/files')) {
     // serve index.html
-    return handleStatic(`${hyperparamPath}/public/index.html`)
-  } else if (pathname.startsWith('/public/')) {
+    return handleStatic(`${hyperparamPath}/dist/index.html`)
+  } else if (pathname.startsWith('/assets/')) {
     // serve static files
-    return handleStatic(`${hyperparamPath}${pathname}`)
+    return handleStatic(`${hyperparamPath}/dist${pathname}`)
+  // else if (pathname.startsWith('/public/')) {
+  //   // serve static files
+  //   return handleStatic(`${hyperparamPath}${pathname.replace(/^(\/public).*/, '/dist')}`)
   } else if (serveDirectory && pathname === '/api/store/list') {
     // serve file list
     const prefix = parsedUrl.query.prefix || ''

packages/cli/src/cli.js bin/cli.jspackages/cli/src/cli.js renamed to bin/cli.js

@@ -100,4 +100,21 @@ export default tseslint.config(
     files: ['**/*.js'],
     ...tseslint.configs.disableTypeChecked,
   },
+  // {
+  //   files: ['bin/**/*.js'],
+  //   plugins: {
+  //     typescript,
+  //   },
+  //   languageOptions: {
+  //     globals: {
+  //       ...globals.browser,
+  //       ...globals.node,
+  //     },
+  //   },
+  //   rules: {
+  //     ...javascript.configs.recommended.rules,
+  //     ...typescript.configs.recommended.rules,
+  //     ...sharedJsRules,
+  //   },
+  // }
 )

packages/cli/src/serve.js bin/serve.jspackages/cli/src/serve.js renamed to bin/serve.js

@@ -5,12 +5,12 @@
     <title>hyperparam</title>
     <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Mulish:wght@400;600&display=swap"/>
     <link href="favicon.png" rel="icon" />
-    <meta name="description" content="demo for the Hyperparam components" />
+    <meta name="description" content="hyperparam is the missing UI for machine learning" />
     <meta name="theme-color" content="#6b00ff">
     <meta name="viewport" content="width=device-width, initial-scale=1" />
   </head>
   <body>
-    <div id="root"></div>
-    <script type="module" src="./src/demo.tsx"></script>
+    <div id="app"></div>
+    <script type="module" src="./src/app.tsx"></script>
   </body>
 </html>

packages/cli/src/streamConverters.js bin/streamConverters.jspackages/cli/src/streamConverters.js renamed to bin/streamConverters.js

@@ -1,18 +1,13 @@
 {
-  "name": "@hyparam/components",
-  "version": "0.1.19",
-  "description": "React components for hyparam apps",
-  "keywords": [
-    "component",
-    "data",
-    "javascript",
-    "react"
-  ],
+  "name": "hyperparam",
+  "version": "0.2.23",
+  "description": "Hyperparam CLI",
+  "author": "Hyperparam",
+  "homepage": "https://hyperparam.app",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/hyparam/hyperparam-cli.git",
-    "directory": "packages/components"
   },
   "type": "module",
   "types": "lib/index.d.ts",
@@ -29,13 +24,17 @@
   ],
   "scripts": {
     "build": "tsc -b && vite build",
-    "coverage": "vitest run --coverage --coverage.include=src",
-    "dev": "vite",
+    "coverage": "vitest run --coverage --coverage.include=src --coverage.include=bin",
+    "dev:vite": "vite",
+    "dev:serve": "npm run serve",
+    "dev:url": "npm run dev:serve -- https://hyperparam.blob.core.windows.net/hyperparam/starcoderdata-js-00000-of-00065.parquet",
     "lint": "eslint .",
     "prepublishOnly": "npm run build",
+    "preview:vite": "vite preview",
+    "serve": "node bin/cli.js",
+    "preserve": "npm run build",
     "test": "vitest run",
-    "typecheck": "tsc --noEmit",
-    "preview": "vite preview"
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "hightable": "0.11.0",