{"_id":"@electric-sql/start","_rev":"5-6f65d1655310cf071e72b8caaae55d83","name":"@electric-sql/start","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@electric-sql/start","version":"1.0.0","keywords":["cli","db","electric","electric-sql","start","starter","tanstack"],"author":{"name":"ElectricSQL team and contributors."},"license":"Apache-2.0","_id":"@electric-sql/start@1.0.0","maintainers":[{"name":"thruflo","email":"thruflo+npm@gmail.com"},{"name":"icehaunter","email":"icehaunter@gmail.com"},{"name":"sgwillis","email":"sam.willis@gmail.com"}],"homepage":"https://electric-sql.com","bugs":{"url":"https://github.com/electric-sql/electric/issues"},"bin":{"start":"dist/cli.js"},"dist":{"shasum":"e012311d54073e841af71393daa7f123f3158a96","tarball":"https://registry.npmjs.org/@electric-sql/start/-/start-1.0.0.tgz","fileCount":12,"integrity":"sha512-UpZYM43UKP0k0wpPk4VMcjJt600CibHdgvI6rexKV3FWbsqcYtuW1RcyayrGNYl+VdC78KJ4Y3ekmKdF6NcwGg==","signatures":[{"sig":"MEUCIQDnZ9NOisCsfF4Copv024Aj91gpLda/B1qaM8lJrFNXZQIgC2ZbkyFRcsKQQS1vIdUWBIbOXJ26e97we+7jIEMF77U=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":42165},"main":"./dist/index.js","type":"module","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./package.json":"./package.json"},"gitHead":"45ae6c5ab33540786eb3c60ccac06d4b390d5551","scripts":{"dev":"pnpm run build && node dist/cli.js","test":"pnpm exec vitest","build":"shx rm -rf dist && tsup","format":"eslint . --fix","prepack":"pnpm build","coverage":"pnpm exec vitest --coverage","typecheck":"tsc -p tsconfig.json","stylecheck":"eslint . --quiet"},"_npmUser":{"name":"icehaunter","email":"icehaunter@gmail.com"},"repository":{"url":"git+https://github.com/electric-sql/electric.git","type":"git"},"_npmVersion":"11.6.2","description":"CLI package for the ElectricSQL Quickstart.","directories":{},"_nodeVersion":"24.11.1","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"shx":"^0.3.4","tsup":"^8.0.1","eslint":"^8.57.0","vitest":"^4.0.15","prettier":"^3.3.2","typescript":"^5.5.2","@types/node":"^20.10.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.14.1","@vitest/coverage-istanbul":"4.0.15","@typescript-eslint/eslint-plugin":"^7.14.1"},"_npmOperationalInternal":{"tmp":"tmp/start_1.0.0_1766593646439_0.2705975026983407","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@electric-sql/start","version":"1.0.1","keywords":["cli","db","electric","electric-sql","start","starter","tanstack"],"author":{"name":"ElectricSQL team and contributors."},"license":"Apache-2.0","_id":"@electric-sql/start@1.0.1","maintainers":[{"name":"thruflo","email":"thruflo+npm@gmail.com"},{"name":"icehaunter","email":"icehaunter@gmail.com"},{"name":"sgwillis","email":"sam.willis@gmail.com"}],"homepage":"https://electric-sql.com","bugs":{"url":"https://github.com/electric-sql/electric/issues"},"bin":{"start":"dist/bin.js"},"dist":{"shasum":"900bddb7071135202e28c8e0f80f3ec30622e2db","tarball":"https://registry.npmjs.org/@electric-sql/start/-/start-1.0.1.tgz","fileCount":14,"integrity":"sha512-xV8yd6GR9/OTwzERqMbL6MLSx+cP9Edg/608V9yHd28jJVubut2OnC5hCiYlZrJ9cGCY/AExl8ZoP1706tyqCw==","signatures":[{"sig":"MEQCIA+dX5/LHUHTrNLzsTm5xZgVQfLlnArYLaCNkKbNfnz4AiB+Ca3Oi2mUhX7GGXVBlYuLnVDx7PSTW1u26JdIhcMz4g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@electric-sql%2fstart@1.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":52113},"main":"./dist/index.js","type":"module","_from":"file:electric-sql-start-1.0.1.tgz","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./package.json":"./package.json"},"scripts":{"dev":"pnpm run build && node dist/bin.js","test":"pnpm exec vitest","build":"shx rm -rf dist && tsup","format":"eslint . --fix","coverage":"pnpm exec vitest --coverage","typecheck":"tsc -p tsconfig.json","stylecheck":"eslint . --quiet"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:77c2366f-864b-41c7-9c94-e413cd283a0d"}},"_resolved":"/tmp/0883ea23884e454d2623d0561cff7be5/electric-sql-start-1.0.1.tgz","_integrity":"sha512-xV8yd6GR9/OTwzERqMbL6MLSx+cP9Edg/608V9yHd28jJVubut2OnC5hCiYlZrJ9cGCY/AExl8ZoP1706tyqCw==","repository":{"url":"git+https://github.com/electric-sql/electric.git","type":"git"},"_npmVersion":"11.6.2","description":"CLI package for the ElectricSQL Quickstart.","directories":{},"_nodeVersion":"24.11.1","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"shx":"^0.3.4","tsup":"^8.0.1","eslint":"^8.57.0","vitest":"^4.0.15","prettier":"^3.3.2","typescript":"^5.5.2","@types/node":"^20.10.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.14.1","@vitest/coverage-istanbul":"4.0.15","@typescript-eslint/eslint-plugin":"^7.14.1"},"_npmOperationalInternal":{"tmp":"tmp/start_1.0.1_1766596420374_0.8614612802274093","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@electric-sql/start","version":"1.0.2","keywords":["cli","db","electric","electric-sql","start","starter","tanstack"],"author":{"name":"ElectricSQL team and contributors."},"license":"Apache-2.0","_id":"@electric-sql/start@1.0.2","maintainers":[{"name":"thruflo","email":"thruflo+npm@gmail.com"},{"name":"icehaunter","email":"icehaunter@gmail.com"},{"name":"sgwillis","email":"sam.willis@gmail.com"}],"homepage":"https://electric-sql.com","bugs":{"url":"https://github.com/electric-sql/electric/issues"},"bin":{"start":"dist/bin.js"},"dist":{"shasum":"8b6378e2ceb24ce515305eec7188aff756854c45","tarball":"https://registry.npmjs.org/@electric-sql/start/-/start-1.0.2.tgz","fileCount":14,"integrity":"sha512-RXIV5MJy5LdXL4KOaI2obc6RAFMD0DHwYujLUrd/bghtds6hyj2fDK3p8uhvGLtUDsaWBowrwqaFHSGkdgpNWw==","signatures":[{"sig":"MEQCIGrK+bRi1BgbFpTpW9WWn9QVmOAVWKf6JfXe/It6zOAoAiAWqY1JeXQorpu3p4hb8WsBbyUOVt/K/6EBmsiTLy8M9w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@electric-sql%2fstart@1.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":52177},"main":"./dist/index.js","type":"module","_from":"file:electric-sql-start-1.0.2.tgz","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./package.json":"./package.json"},"scripts":{"dev":"pnpm run build && node dist/bin.js","test":"pnpm exec vitest","build":"shx rm -rf dist && tsup","format":"eslint . --fix","coverage":"pnpm exec vitest --coverage","typecheck":"tsc -p tsconfig.json","stylecheck":"eslint . --quiet"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:77c2366f-864b-41c7-9c94-e413cd283a0d"}},"_resolved":"/tmp/0a50882490f6c3a7f9bc6edcd795da66/electric-sql-start-1.0.2.tgz","_integrity":"sha512-RXIV5MJy5LdXL4KOaI2obc6RAFMD0DHwYujLUrd/bghtds6hyj2fDK3p8uhvGLtUDsaWBowrwqaFHSGkdgpNWw==","repository":{"url":"git+https://github.com/electric-sql/electric.git","type":"git"},"_npmVersion":"11.6.2","description":"CLI package for the ElectricSQL Quickstart.","directories":{},"_nodeVersion":"24.11.1","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"shx":"^0.3.4","tsup":"^8.0.1","eslint":"^8.57.0","vitest":"^4.0.15","prettier":"^3.3.2","typescript":"^5.5.2","@types/node":"^20.10.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.14.1","@vitest/coverage-istanbul":"4.0.15","@typescript-eslint/eslint-plugin":"^7.14.1"},"_npmOperationalInternal":{"tmp":"tmp/start_1.0.2_1766597556344_0.47608715498124843","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@electric-sql/start","version":"1.0.3","keywords":["cli","db","electric","electric-sql","start","starter","tanstack"],"author":{"name":"ElectricSQL team and contributors."},"license":"Apache-2.0","_id":"@electric-sql/start@1.0.3","maintainers":[{"name":"thruflo","email":"thruflo+npm@gmail.com"},{"name":"icehaunter","email":"icehaunter@gmail.com"},{"name":"sgwillis","email":"sam.willis@gmail.com"}],"homepage":"https://electric-sql.com","bugs":{"url":"https://github.com/electric-sql/electric/issues"},"bin":{"start":"dist/bin.js"},"dist":{"shasum":"f46bc952e7dc99304aa7635422fb8f57569ea0f8","tarball":"https://registry.npmjs.org/@electric-sql/start/-/start-1.0.3.tgz","fileCount":14,"integrity":"sha512-/BvxCZffoQwHS95whtPtSlUoXrsNYL3rh0FiBuOdlKKZNPevrC+/0xuCJ+sqwVVaNDuhKGxhpvjyFo8+QKHyUg==","signatures":[{"sig":"MEQCIEtjTeq3iab01V4OShNCd9eoZowDIn2oV+ysCP6OKjLbAiANHnKNL/lPscW0sv/Fp6FoDd/v6FLupcRopJfjlLWgyQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@electric-sql%2fstart@1.0.3","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":69901},"main":"./dist/index.js","type":"module","_from":"file:electric-sql-start-1.0.3.tgz","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./package.json":"./package.json"},"scripts":{"dev":"pnpm run build && node dist/bin.js","test":"pnpm exec vitest","build":"shx rm -rf dist && tsup","format":"eslint . --fix","coverage":"pnpm exec vitest --coverage","typecheck":"tsc -p tsconfig.json","stylecheck":"eslint . --quiet"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:77c2366f-864b-41c7-9c94-e413cd283a0d"}},"_resolved":"/tmp/768ea9fcfd5f1f1d5a2db57a82720777/electric-sql-start-1.0.3.tgz","_integrity":"sha512-/BvxCZffoQwHS95whtPtSlUoXrsNYL3rh0FiBuOdlKKZNPevrC+/0xuCJ+sqwVVaNDuhKGxhpvjyFo8+QKHyUg==","repository":{"url":"git+https://github.com/electric-sql/electric.git","type":"git"},"_npmVersion":"11.6.2","description":"CLI package for the ElectricSQL Quickstart.","directories":{},"_nodeVersion":"24.11.1","dependencies":{},"_hasShrinkwrap":false,"devDependencies":{"shx":"^0.3.4","tsup":"^8.0.1","eslint":"^8.57.0","vitest":"^4.0.15","prettier":"^3.3.2","typescript":"^5.5.2","@types/node":"^20.10.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","@typescript-eslint/parser":"^7.14.1","@vitest/coverage-istanbul":"4.0.15","@typescript-eslint/eslint-plugin":"^7.14.1"},"_npmOperationalInternal":{"tmp":"tmp/start_1.0.3_1768410871956_0.4534511761524489","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-12-24T16:27:26.358Z","modified":"2026-01-30T21:50:06.500Z","1.0.0":"2025-12-24T16:27:26.589Z","1.0.1":"2025-12-24T17:13:40.511Z","1.0.2":"2025-12-24T17:32:36.481Z","1.0.3":"2026-01-14T17:14:32.086Z"},"bugs":{"url":"https://github.com/electric-sql/electric/issues"},"author":{"name":"ElectricSQL team and contributors."},"license":"Apache-2.0","homepage":"https://electric-sql.com","keywords":["cli","db","electric","electric-sql","start","starter","tanstack"],"repository":{"url":"git+https://github.com/electric-sql/electric.git","type":"git"},"description":"CLI package for the ElectricSQL Quickstart.","maintainers":[{"email":"thruflo+npm@gmail.com","name":"thruflo"},{"email":"icehaunter@gmail.com","name":"icehaunter"},{"email":"mathews.kyle@gmail.com","name":"kylemathews"},{"email":"sam.willis@gmail.com","name":"sgwillis"}],"readme":"# @electric-sql/start\n\nCLI package for the [ElectricSQL Quickstart](https://electric-sql.com/docs/quickstart).\n\n## Usage\n\nCreate a new app using [Electric](https://electric-sql.com/product/electric) with [TanStack DB](https://tanstack.com/db), based on the [examples/tanstack-db-web-starter](https://github.com/electric-sql/electric/tree/main/examples/tanstack-db-web-starter) [TanStack Start](http://tanstack.com/start) template app:\n\n```bash\npnpx @electric-sql/start my-electric-app\n```\n\nThis command will:\n\n1. pull in the template app using gitpick\n2. provision cloud resources\n   - a Postgres database using Neon\n   - an Electric sync service using Electric Cloud\n   - fetch their access credentials\n3. configure the local `.env` to use the credentials\n4. add `psql`, `claim` and `deploy` commands to the package.json\n   - also using the generated credentials\n\n## Environment Variables\n\nThe CLI automatically generates these environment variables:\n\n- `DATABASE_URL` - PostgreSQL connection string\n- `ELECTRIC_SECRET` - Electric Cloud authentication secret\n- `ELECTRIC_SOURCE_ID` - Electric sync service identifier\n\n## Commands\n\n```bash\npnpm dev          # Start development server\npnpm psql         # Connect to PostgreSQL database\npnpm claim        # Claim temporary resources\npnpm deploy       # Deploy to Netlify\n```\n\n### `pnpm psql`\n\nConnect directly to your PostgreSQL database using the configured `DATABASE_URL`:\n\n### `pnpm claim`\n\nClaim temporary resources to move them to your permanent Electric Cloud and Neon accounts.\n\n### `pnpm deploy`\n\nDeploy your app to Netlify with all environment variables configured.\n\n## Development\n\nThis package is part of the Electric monorepo. To work on it:\n\n```bash\n# From the monorepo root\npnpm install   # Install all workspace dependencies\npnpm build     # Build all packages\n\n# From packages/quickstart\npnpm build     # Compile TypeScript\npnpm dev       # Build and test locally\n```\n\n### Testing Against Different API Environments\n\nThe Electric API base URL can be configured via the `ELECTRIC_API_BASE_URL` environment variable. This is useful for testing against staging or development API servers.\n\n```bash\n# Default (production)\npnpm test\n\n# Against a custom API server\nELECTRIC_API_BASE_URL=https://api.staging.electric-sql.cloud pnpm test\n```\n\nThe default API base URL is `https://api.electric-sql.cloud`.\n","readmeFilename":"README.md"}