Skip to content

Commit 2421a44

Browse files
authored
Merge pull request #2534 from appwrite/fix-manual-deployment-snippet
fix: manual deployment snippet
2 parents a5a4fbb + aba51bb commit 2421a44

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

AGENTS.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Appwrite Console is the web-based GUI for the Appwrite backend-as-a-service plat
1111
1. **Install pnpm**: `npm install -g corepack && corepack enable && corepack prepare [email protected] --activate`
1212
2. **Create .env**: `cp .env.example .env` (configure `PUBLIC_APPWRITE_ENDPOINT` and `PUBLIC_CONSOLE_MODE`)
1313
3. **Configure network access** (if using GitHub Actions or restricted environments):
14-
- Ensure firewall/proxy allows access to: `pkg.pr.new`, `pkg.vc`, `registry.npmjs.org`
15-
- These domains are required for dependencies: `@appwrite.io/console`, `@appwrite.io/pink-icons-svelte`, `@appwrite.io/pink-svelte`
16-
- In GitHub Actions: Use `pnpm/action-setup@v4` which handles registry configuration
17-
- If network errors persist, check proxy settings: `npm config get proxy` and `npm config get https-proxy`
14+
- Ensure firewall/proxy allows access to: `pkg.pr.new`, `pkg.vc`, `registry.npmjs.org`
15+
- These domains are required for dependencies: `@appwrite.io/console`, `@appwrite.io/pink-icons-svelte`, `@appwrite.io/pink-svelte`
16+
- In GitHub Actions: Use `pnpm/action-setup@v4` which handles registry configuration
17+
- If network errors persist, check proxy settings: `npm config get proxy` and `npm config get https-proxy`
1818
4. **Install dependencies**: `pnpm install --frozen-lockfile` (if pkg.pr.new/pkg.vc fail due to network restrictions, installation may still succeed with cached versions)
1919

2020
### Development Commands
@@ -70,12 +70,12 @@ src/
7070
## Common Pitfalls
7171

7272
1. **Blank page in dev**: Disable ad blockers if seeing "Failed to fetch dynamically imported module" (known SvelteKit issue)
73-
2. **Network errors on install**:
74-
- pkg.pr.new/pkg.vc deps may fail due to firewall/proxy restrictions
75-
- Check access: `curl -I https://pkg.pr.new` and `curl -I https://pkg.vc`
76-
- Configure proxy if needed: `npm config set proxy http://proxy:port` and `npm config set https-proxy http://proxy:port`
77-
- GitHub Actions: Ensure runner has internet access; use `pnpm/action-setup@v4` action
78-
- Local dev: Often safe to continue with cached versions if network fails
73+
2. **Network errors on install**:
74+
- pkg.pr.new/pkg.vc deps may fail due to firewall/proxy restrictions
75+
- Check access: `curl -I https://pkg.pr.new` and `curl -I https://pkg.vc`
76+
- Configure proxy if needed: `npm config set proxy http://proxy:port` and `npm config set https-proxy http://proxy:port`
77+
- GitHub Actions: Ensure runner has internet access; use `pnpm/action-setup@v4` action
78+
- Local dev: Often safe to continue with cached versions if network fails
7979
3. **OOM on build**: Set `NODE_OPTIONS=--max_old_space_size=8192` (like Dockerfile does)
8080
4. **Test failures**: Always use `pnpm run test` (sets TZ=EST), not `vitest` directly
8181
5. **TS errors not showing**: Run `pnpm run check` explicitly (dev server doesn't always surface them)

src/routes/(console)/project-[region]-[project]/functions/function-[function]/(modals)/createCli.svelte

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,26 +54,26 @@
5454
function setCodeSnippets() {
5555
return {
5656
Unix: {
57-
code: `appwrite client --projectId="${page.params.project}" && \\
58-
appwrite functions createDeployment \\
59-
--functionId=${functionId} \\
57+
code: `appwrite client --project-id="${page.params.project}" && \\
58+
appwrite functions create-deployment \\
59+
--function-id=${functionId} \\
6060
--code="." \\
6161
--activate=true`,
6262
language: 'bash'
6363
},
6464
6565
CMD: {
66-
code: `appwrite client --projectId="${page.params.project}" && ^
67-
appwrite functions createDeployment ^
68-
--functionId=${functionId} ^
66+
code: `appwrite client --project-id="${page.params.project}" && ^
67+
appwrite functions create-deployment ^
68+
--function-id=${functionId} ^
6969
--code="." ^
7070
--activate`,
7171
language: 'CMD'
7272
},
7373
PowerShell: {
74-
code: `appwrite client --projectId="${page.params.project}" && ,
75-
appwrite functions createDeployment ,
76-
--functionId=${functionId} ,
74+
code: `appwrite client --project-id="${page.params.project}" && ,
75+
appwrite functions create-deployment ,
76+
--function-id=${functionId} ,
7777
--code="." ,
7878
--activate`,
7979
language: 'PowerShell'

src/routes/(console)/project-[region]-[project]/sites/site-[site]/deployments/createCliModal.svelte

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
3838
return {
3939
Unix: {
40-
code: `appwrite client --projectId="${projectId}" && \\
40+
code: `appwrite client --project-id="${projectId}" && \\
4141
appwrite sites create-deployment \\
4242
--site-id="${siteId}" \\
4343
--code="${codePath}" \\
@@ -49,9 +49,9 @@ appwrite sites create-deployment \\
4949
},
5050
5151
CMD: {
52-
code: `appwrite client --projectId="${projectId}" && ^
53-
appwrite sites createDeployment ^
54-
--siteId=${siteId} ^
52+
code: `appwrite client --project-id="${projectId}" && ^
53+
appwrite sites create-deployment ^
54+
--site-id=${siteId} ^
5555
--code="${codePath}" ^
5656
--activate ^
5757
--build-command="${buildCommand}" ^
@@ -61,9 +61,9 @@ appwrite sites createDeployment ^
6161
},
6262
6363
PowerShell: {
64-
code: `appwrite client --projectId="${projectId}" ;
65-
appwrite sites createDeployment ,
66-
--siteId=${siteId} ,
64+
code: `appwrite client --project-id="${projectId}" ;
65+
appwrite sites create-deployment ,
66+
--site-id=${siteId} ,
6767
--code="${codePath}" ,
6868
--activate ,
6969
--build-command="${buildCommand}" ,

0 commit comments

Comments
 (0)