phio 0.3.5 → 0.4.0

package/CHANGELOG.md

@@ -0,0 +1,141 @@
+# phio
+
+## 0.4.0
+
+### Minor Changes
+
+- SFTP deploy and dev sync (`ftp.pockethost.io:2222`, Ed25519 key auth)
+- `phio sftp` — interactive SFTP via system client (`--print` for the command line)
+- Auto-provision deploy key labeled `Phio` under Account → Keys
+- Project instance linking via `.phioconfig` (migrates legacy `package.json` / `pockethost.json`)
+- Walk up to project root from subdirectories before sync
+
+## 0.3.5
+
+### Patch Changes
+
+- Fix: add support for bun.lock
+
+## 0.3.4
+
+### Patch Changes
+
+- 24988ee: Feat: logout command
+- de7168b: Fix: various auth fixes
+- 6262058: Fix: use correct token for log watching
+- 5d28256: Enhance logs command with improved streaming and error handling
+
+## 0.3.3
+
+### Patch Changes
+
+- 4bf6d1e: Fix: use client auth token instead of stored token
+
+## 0.3.2
+
+### Patch Changes
+
+- b85e156: Fix: nodev22 compat
+
+## 0.3.1
+
+### Patch Changes
+
+- fd128bc: Node v22 compat
+
+## 0.3.0
+
+### Minor Changes
+
+- 82b4c6b: Add support for PHIO_USERNAME, PHIO_PASSWORD, and PHIO_INSTANCE_NAME env vars
+- 82b4c6b: Migrate to instance names only (no IDs)
+- 82b4c6b: Remove support for global instance name - local package.json or pockethost.json required now
+
+### Patch Changes
+
+- 1b46e08: Alphabetize instance lists
+- 82b4c6b: Improved error message reporting
+
+## 0.2.5
+
+### Patch Changes
+
+- 283da4e: Add 'info' command
+- b17fca2: Add error handling when 'link' returns no instances
+- 8aaa611: Add 'ls' alias
+
+## 0.2.4
+
+### Patch Changes
+
+- Fix: --include and --exclude now parse comma separated values correctly
+
+## 0.2.3
+
+### Patch Changes
+
+- Fix: bad include path
+
+## 0.2.2
+
+### Patch Changes
+
+- 467c4ba: Enh: Validate auth before tailing instance logs
+- 4e8ddb5: Fix: auth token now stored correctly after refresh
+
+## 0.2.1
+
+### Patch Changes
+
+- Fix: Link now uses package.json
+
+## 0.2.0
+
+### Minor Changes
+
+- Introduced deploy command
+
+### Patch Changes
+
+- Command refactoring
+
+## 0.1.2
+
+### Patch Changes
+
+- Enh: add --verbose flag to dev mode
+
+## 0.1.1
+
+### Patch Changes
+
+- Fix: include and exclude defaults
+
+## 0.1.0
+
+### Minor Changes
+
+- afc6e91: Added `link` command to link to a specific instance
+- fff79df: pockethost.io now runs `bun install` when uploading a `bun.lockb`
+- 9fc57d6: Added whoami command
+- 9fc57d6: Added list command
+- afc6e91: Added --include and --exclude options to dev watch mode
+
+### Patch Changes
+
+- afc6e91: Fix: log tailer will now restart on disconnect
+- fff79df: Enh: watcher now looks for package.json and bun.lockb
+- fff79df: Fix: watcher was incorrectly applying --include and --exclude
+- fff79df: Enh: watcher now queues successive deployments that happen in rapid succession
+
+## 0.0.2
+
+### Patch Changes
+
+- Forgot tsx dep
+
+## 0.0.1
+
+### Patch Changes
+
+- a5bf2f3: Initial version

package/README.md

@@ -1,66 +1,75 @@
-# phio: the pockethost.io CLI
+# phio: the PocketHost CLI
 
-**Auth**
+Install globally (Node.js 24+):
 
 ```bash
-bunx phio login
-bunx phio logout
-bunx phio whoami
+npm install -g phio
 ```
 
-**List instances**
+From the monorepo:
 
 ```bash
-bunx phio list
+pnpm dev:phio -- --help
+pnpm --filter phio dev -- login
 ```
 
-**Watch and push local changes instantly**
+## Commands
 
 ```bash
-bunx phio dev [instance]
+phio login
+phio logout
+phio info          # alias: phio whoami
+phio list
+phio link [instance]
+phio dev [instance]
+phio deploy [instance]
+phio sftp [instance]
+phio logs [instance]
 ```
 
-**Deploy to remote**
+- **`phio dev`** — watch local changes and sync over SFTP
+- **`phio deploy`** — one-shot SFTP sync
+- **`phio sftp`** — interactive SFTP session (uses system `sftp` when available)
+- **`phio logs`** — tail instance logs
 
-```bash
-bunx phio deploy [instance]
-```
+`dev` and `deploy` accept `-v/--verbose`, `-i/--include`, and `-e/--exclude`.
 
-**Tail logs**
+Default includes: `pb_*`, `package.json`, `bun.lock`, `bun.lockb`, `patches/**`.
 
-```bash
-bunx phio logs [instance]
-```
+Default excludes: `pb_data/**`.
 
 ## Configuration
 
-Use `pockethost` in your `package.json` to save your instance name so you don't need to keep typing it:
+Link a project directory to an instance:
 
-```json
-// package.json
-{
-  "pockethost": {
-    "instanceName": "all-your-base"
-  }
-}
+```bash
+phio link my-instance
 ```
 
--or-
-
-Use `pockethost.json` to save your instance name so you don't need to keep typing it.
+This writes `.phioconfig`:
 
 ```json
 {
-  "instanceName": "all-your-base"
+  "instanceName": "my-instance"
 }
 ```
 
-## Environment Variables
+Legacy `package.json` (`pockethost.instanceName`) and `pockethost.json` are migrated to `.phioconfig` automatically on first use.
+
+## Deploy key
+
+`phio dev` and `phio deploy` sync over **SFTP** (`ftp.pockethost.io:2222`) using an Ed25519 deploy key stored under `PHIO_HOME` (default `~/.config/phio/`). phio auto-registers a **`Phio`** key under Account → Keys on first use. Run `phio info` to inspect key status.
+
+Customer docs: https://pockethost.io/docs/phio
 
-The following environment variables can be used to override any saved configuration:
+## Environment variables
 
-- `PHIO_USERNAME` - Override saved username
-- `PHIO_PASSWORD` - Override saved password
-- `PHIO_INSTANCE_NAME` - Override saved instance name
+| Variable | Purpose |
+| -------- | ------- |
+| `PHIO_USERNAME` | Override saved email (non-interactive login) |
+| `PHIO_PASSWORD` | Override saved password |
+| `PHIO_INSTANCE_NAME` | Override linked instance name |
+| `PHIO_MOTHERSHIP_URL` | Override mothership API URL |
+| `PHIO_HOME` | Override phio config directory |
 
-Environment variables take precedence over configuration in package.json or pockethost.json.
+Environment variables take precedence over `.phioconfig`.

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "phio",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "A CLI tool to manage your PocketHost instances",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pockethost/phio.git"
+    "url": "https://github.com/pockethost/pockethost.git",
+    "directory": "packages/phio"
   },
-  "homepage": "https://github.com/pockethost/phio",
+  "homepage": "https://pockethost.io",
   "keywords": [
     "cli",
     "pocketbase",
@@ -15,33 +16,34 @@
   "author": "Ben Allfree",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pockethost/phio/issues"
+    "url": "https://github.com/pockethost/pockethost/issues"
   },
+  "type": "module",
   "main": "src/index.ts",
   "module": "src/index.ts",
-  "type": "module",
   "types": "src/index.ts",
-  "devDependencies": {
-    "@changesets/cli": "^2.28.1",
-    "@types/bun": "^1.2.3",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.13.5",
-    "prettier-plugin-organize-imports": "^4.1.0"
-  },
-  "scripts": {
-    "dev": "tsx ./src/cli.ts"
-  },
   "bin": {
     "phio": "src/cli.ts"
   },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "check:types": "tsc --noEmit",
+    "dev": "node --import tsx ./src/cli.ts",
+    "start": "node --import tsx ./src/cli.ts"
+  },
   "files": [
-    "src"
+    "src",
+    "vendor",
+    "CHANGELOG.md",
+    "README.md"
   ],
   "dependencies": {
     "@inquirer/prompts": "^7.3.2",
+    "@microsoft/fetch-event-source": "github:pockethost/fetch-event-source#ebe3b7122647b48b93fd11effbbfb915d98956b0",
     "@s-libs/micro-dash": "^18.0.0",
-    "@samkirkland/ftp-deploy": "github:benallfree/ftp-deploy#132389e",
-    "@sentool/fetch-event-source": "github:pockethost/sentool-fetch-event-source#c975adc3cdf9c645bf094b0b8a28454699075e22",
+    "basic-ftp": "^5.0.5",
     "bottleneck": "^2.19.5",
     "chokidar": "^4.0.3",
     "commander": "^13.1.0",
@@ -50,18 +52,26 @@
     "env-var": "^7.5.0",
     "event-stream": "^4.0.1",
     "fs-extra": "^11.3.0",
+    "glob": "^11.0.0",
+    "lodash": "^4.17.21",
     "multimatch": "^7.0.0",
     "ora": "^8.2.0",
     "pocketbase": "^0.25.1",
+    "pretty-bytes": "^5.6.0",
+    "pretty-ms": "^7.0.1",
+    "ssh2-sftp-client": "^12.1.1",
     "tsx": "^4.19.3",
+    "yargs": "^17.7.1"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^24.0.0",
+    "@types/ssh2-sftp-client": "^9.0.6",
     "typescript": "^5.7.3"
   },
   "prettier": {
     "semi": false,
     "singleQuote": true,
-    "trailingComma": "es5",
-    "plugins": [
-      "prettier-plugin-organize-imports"
-    ]
+    "trailingComma": "es5"
   }
 }

package/src/cli.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env tsx
 import { program } from 'commander'
 import { version } from '../package.json'
+import { ensurePhioRoot } from './lib/phioRoot'
 import { DeployCommand } from './commands/DeployCommand'
 import { DevCommand } from './commands/DevCommand'
 import { InfoCommand } from './commands/InfoCommand'
@@ -9,7 +10,9 @@ import { ListCommand } from './commands/ListCommand'
 import { LoginCommand } from './commands/LoginCommand'
 import { LogoutCommand } from './commands/LogoutCommand'
 import { LogsCommand } from './commands/LogsCommand'
-import { WhoAmICommand } from './commands/WhoAmICommand'
+import { SftpCommand } from './commands/SftpCommand'
+
+ensurePhioRoot()
 
 program
   .name(`PocketHost CLI`)
@@ -18,18 +21,20 @@ program
   .addCommand(LoginCommand())
   .addCommand(LogsCommand())
   .addCommand(DevCommand())
-  .addCommand(WhoAmICommand())
   .addCommand(ListCommand())
   .addCommand(LinkCommand())
   .addCommand(DeployCommand())
+  .addCommand(SftpCommand())
   .addCommand(LogoutCommand())
   .addCommand(InfoCommand())
 
 // Add error handling
 program.exitOverride()
 
-program.parseAsync(process.argv).catch((err) => {
-  // Handle specific commander error types
+program.parseAsync(process.argv).catch((err: NodeJS.ErrnoException & { code?: string }) => {
+  if (err.code === 'commander.helpDisplayed' || err.code === 'commander.help' || err.code === 'commander.version') {
+    process.exit(0)
+  }
   if (err.code === 'commander.unknownCommand') {
     console.error('Error: Unknown command')
   } else if (err.code === 'commander.missingArgument') {

package/src/commands/DevCommand.ts

@@ -1,10 +1,13 @@
 import { debounce } from '@s-libs/micro-dash'
-import { deploy, excludeDefaults } from '@samkirkland/ftp-deploy'
-import { IFtpDeployArguments } from '@samkirkland/ftp-deploy/src/types'
+import { deploy, excludeDefaults } from '../../vendor/ftp-deploy/module.js'
+import type { IFtpDeployArguments } from '../../vendor/ftp-deploy/types.js'
 import Bottleneck from 'bottleneck'
 import { watch } from 'chokidar'
 import { Command } from 'commander'
 import multimatch from 'multimatch'
+import { ensureDeployKey } from '../lib/deployKey'
+import { PHIO_CONFIG_FILE } from '../lib/constants'
+import { PHIO_SFTP_HOST, PHIO_SFTP_PORT } from '../lib/sftpConnection'
 import { ensureLoggedIn } from '../lib/ensureLoggedIn'
 import { getClient, getInstanceBySubdomainCnameOrId } from '../lib/getClient'
 import { savedInstanceName } from './../lib/defaultInstanceId'
@@ -37,7 +40,7 @@ export const watchAndDeploy = async (
 ) => {
   if (!instanceName) {
     throw new Error(
-      `No instance name provided and none was found in package.json or pockethost.json. Use 'phio link <instance>'`
+      `No instance name provided and none was found in ${PHIO_CONFIG_FILE}. Use 'phio link <instance>'`
     )
   }
   console.log(`Dev mode`)
@@ -104,11 +107,19 @@ export async function deployMyCode(
 ) {
   await ensureLoggedIn()
   const client = await getClient()
+  const { privateKeyPath } = await ensureDeployKey(client)
+  const email = client.authStore.record?.email
+  if (!email) {
+    throw new Error(`You must be logged in first. Use 'phio login'`)
+  }
+
   console.log(`🚚 Deploy started for ${instanceName}`)
   const args: IFtpDeployArguments = {
-    server: 'ftp.pockethost.io',
-    username: `__auth__`,
-    password: client.authStore.exportToCookie(),
+    server: PHIO_SFTP_HOST,
+    protocol: 'sftp',
+    port: PHIO_SFTP_PORT,
+    username: email,
+    'private-key-path': privateKeyPath,
     'server-dir': `${instanceName}/`,
     include,
     exclude: [...excludeDefaults, ...exclude],

package/src/commands/InfoCommand.ts

@@ -1,10 +1,33 @@
 import { Command } from 'commander'
+import { DEPLOY_KEY_LABEL, ensureDeployKey, formatDeployKeyRemoteStatus, getDeployKeyStatus } from '../lib/deployKey'
 import { PHIO_HOME } from '../lib/constants'
 import { savedInstanceName } from '../lib/defaultInstanceId'
+import { resolveAuthStatus } from '../lib/getClient'
+
+export const showInfo = async () => {
+  const auth = await resolveAuthStatus()
+
+  if (auth.state !== 'authenticated') {
+    console.log(`Not logged in. Run 'phio login'.`)
+    return
+  }
+
+  await ensureDeployKey(auth.client)
+  const status = await getDeployKeyStatus(auth.client)
+
+  console.log(`Config root: ${PHIO_HOME()}`)
+  console.log(`Logged in as: ${auth.email}`)
+  console.log(`Instance: ${savedInstanceName() || '(not linked)'}`)
+  console.log(`Deploy key label: ${DEPLOY_KEY_LABEL}`)
+  console.log(`Deploy key private: ${status.privateKeyPath}`)
+  console.log(`Deploy key public: ${status.publicKeyPath}`)
+  console.log(`Deploy key fingerprint: ${status.fingerprint}`)
+  console.log(`Deploy key remote: ${formatDeployKeyRemoteStatus(status.remote)}`)
+}
 
 export const InfoCommand = () => {
-  return new Command(`info`).description(`Get config info`).action(() => {
-    console.log(`Config root: ${PHIO_HOME()}`)
-    console.log(`Instance: ${savedInstanceName()}`)
-  })
+  return new Command(`info`)
+    .alias(`whoami`)
+    .description(`Show login and config info`)
+    .action(showInfo)
 }

package/src/commands/LinkCommand.ts

@@ -5,7 +5,7 @@ import { InstanceFields } from '../lib/InstanceFields'
 import { getClient, getInstanceBySubdomainCnameOrId } from './../lib/getClient'
 
 export const link = async (instanceName: string) => {
-  saveInstanceName(instanceName, 'package.json')
+  saveInstanceName(instanceName)
   const instance = await getInstanceBySubdomainCnameOrId(instanceName)
   if (!instance) {
     return

package/src/commands/LogsCommand.ts

@@ -1,4 +1,4 @@
-import { fetchEventSource } from '@sentool/fetch-event-source'
+import { fetchEventSource } from '../lib/fetchEventSource.js'
 import { Command } from 'commander'
 import { savedInstanceName } from '../lib/defaultInstanceId'
 import { ensureLoggedIn } from '../lib/ensureLoggedIn'
@@ -16,7 +16,7 @@ export type InstanceLogFields = {
 }
 
 type EventSourceMessage = {
-  data: InstanceLogFields | null
+  data: string
 }
 
 type Unsubscribe = () => void
@@ -58,6 +58,11 @@ const watchInstanceLog = async (
 
   // Create promise that will resolve when streaming ends
   const streamingPromise = new Promise<void>((resolve, reject) => {
+    signal.addEventListener('abort', () => {
+      clearPendingTimeouts()
+      resolve()
+    })
+
     const continuallyFetchFromEventSource = () => {
       // Don't attempt to reconnect if we're aborting
       if (isAborting) {
@@ -80,9 +85,13 @@ const watchInstanceLog = async (
         openWhenHidden: true,
         body: JSON.stringify(body),
         onmessage: (event: EventSourceMessage) => {
-          const { data } = event
-          if (!data || isAborting) return
-          update(data)
+          if (isAborting) return
+          try {
+            const data = JSON.parse(event.data) as InstanceLogFields
+            update(data)
+          } catch {
+            // ignore malformed lines
+          }
         },
         onopen: async (response: Response) => {
           if (!response.ok) {
@@ -102,15 +111,9 @@ const watchInstanceLog = async (
           if (isAborting) return
           console.log(`Log stream closed. Reconnecting...`)
 
-          // Clear any existing timeout before setting a new one
           clearPendingTimeouts()
           retryTimeout = setTimeout(continuallyFetchFromEventSource, 100)
         },
-        onabort: () => {
-          console.log(`Log stream aborted`)
-          clearPendingTimeouts()
-          resolve()
-        },
         signal,
       })
     }

package/src/commands/SftpCommand.ts

@@ -0,0 +1,99 @@
+import { spawn, spawnSync } from 'child_process'
+import { Command } from 'commander'
+import { ensureDeployKey } from '../lib/deployKey'
+import { PHIO_CONFIG_FILE } from '../lib/constants'
+import { savedInstanceName } from '../lib/defaultInstanceId'
+import { ensureLoggedIn } from '../lib/ensureLoggedIn'
+import { getClient, getInstanceBySubdomainCnameOrId } from '../lib/getClient'
+import {
+  formatSftpCommand,
+  PHIO_SFTP_HOST,
+  PHIO_SFTP_PORT,
+  type SftpConnection,
+  buildSftpArgs,
+} from '../lib/sftpConnection'
+
+const findSftpExecutable = (): string | null => {
+  const lookup = process.platform === 'win32' ? 'where' : 'which'
+  const result = spawnSync(lookup, ['sftp'], { encoding: 'utf8' })
+  if (result.status !== 0) {
+    return null
+  }
+  const line = result.stdout.trim().split(/\r?\n/)[0]?.trim()
+  return line || null
+}
+
+const resolveRemoteDir = async (instanceName?: string) => {
+  const name = instanceName || savedInstanceName()
+  if (!name) {
+    return ''
+  }
+
+  try {
+    const instance = await getInstanceBySubdomainCnameOrId(name)
+    return `${instance.subdomain}/`
+  } catch {
+    throw new Error(`Instance ${name} not found`)
+  }
+}
+
+export const openSftpSession = async (instanceName?: string, printOnly = false) => {
+  if (!instanceName && !savedInstanceName()) {
+    console.log(`No linked instance in ${PHIO_CONFIG_FILE}. Opening SFTP at instance root.`)
+  }
+
+  await ensureLoggedIn()
+  const client = await getClient()
+  const { privateKeyPath } = await ensureDeployKey(client)
+  const email = client.authStore.record?.email
+  if (!email) {
+    throw new Error(`You must be logged in first. Use 'phio login'`)
+  }
+
+  const connection: SftpConnection = {
+    host: PHIO_SFTP_HOST,
+    port: PHIO_SFTP_PORT,
+    username: email,
+    privateKeyPath,
+    remoteDir: await resolveRemoteDir(instanceName),
+  }
+
+  const commandLine = formatSftpCommand(connection)
+
+  if (printOnly) {
+    console.log(commandLine)
+    return
+  }
+
+  const sftpBin = findSftpExecutable()
+  if (!sftpBin) {
+    console.error(`Could not find 'sftp' on PATH. Install OpenSSH client tools, then run:`)
+    console.error('')
+    console.error(commandLine)
+    console.error('')
+    console.error('See https://pockethost.io/docs/ftp for client setup.')
+    process.exit(1)
+  }
+
+  const child = spawn(sftpBin, buildSftpArgs(connection), { stdio: 'inherit' })
+  await new Promise<void>((_resolve, reject) => {
+    child.on('error', reject)
+    child.on('close', (code, signal) => {
+      if (signal) {
+        process.kill(process.pid, signal)
+        return
+      }
+      process.exit(code ?? 0)
+    })
+  })
+}
+
+export const SftpCommand = () => {
+  return new Command('sftp')
+    .argument(`[instanceName]`, `Instance name`, savedInstanceName())
+    .description(`Open an interactive SFTP session to your instance files`)
+    .option(`--print`, `Print the sftp command instead of running it`)
+    .action(async (instanceName, options) => {
+      await openSftpSession(instanceName || undefined, options.print)
+    })
+}

package/src/lib/constants.ts

@@ -27,3 +27,5 @@ export const PHIO_USERNAME = () => env.get('PHIO_USERNAME').asString() || ''
 export const PHIO_PASSWORD = () => env.get('PHIO_PASSWORD').asString() || ''
 export const PHIO_INSTANCE_NAME = () =>
   env.get('PHIO_INSTANCE_NAME').asString() || ''
+
+export const PHIO_CONFIG_FILE = '.phioconfig'