@webship.co/workspace-godaddy 1.0.8 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/ai/agents/godaddy-deployer.md +88 -0
- package/ai/commands/godaddy-status.md +49 -0
- package/ai/prompts/godaddy-test-then-deploy.md +27 -0
- package/ai/skills/godaddy-hosting/SKILL.md +108 -0
- package/dist/src/index.d.ts +5 -0
- package/dist/src/index.js +6 -1
- package/dist/src/index.js.map +1 -1
- package/docs/plugin-items-pattern.md +14 -0
- package/features/godaddy.feature +16 -0
- package/package.json +44 -3
- package/scripts/args/arg-godaddy.sh +2 -2
package/README.md
CHANGED
|
@@ -20,6 +20,41 @@ bash core/scripts/plugins.sh --configure godaddy # core/config/plugin.godad
|
|
|
20
20
|
|
|
21
21
|
The same four steps are buttons on the dashboard's **Settings → Plugins** page.
|
|
22
22
|
|
|
23
|
+
## The items it carries
|
|
24
|
+
|
|
25
|
+
The workspace is container-based (DDEV by default). Each item lands in the folder of its kind, when
|
|
26
|
+
that folder is an active workspace folder, is listed there like any other item, and is installed
|
|
27
|
+
into Claude Code from there:
|
|
28
|
+
|
|
29
|
+
| What | Lands in | What it is for |
|
|
30
|
+
| --- | --- | --- |
|
|
31
|
+
| The agent `godaddy-deployer` | `ai-agents/` | Says whether a site is linked to GoDaddy and to what, reads its environments and its log, brings the live data here when asked, tests it before a deploy, and hands over the deploy line |
|
|
32
|
+
| The skill `godaddy-hosting` | `ai-skills/` | Every entry of the GODADDY menu and the command behind it, each option of `cmd-tools-godaddy.sh`, the link, the keys of `plugin.godaddy.settings.yml` |
|
|
33
|
+
| The command `/godaddy-status` | `ai-commands/` | `/godaddy-status <project>`: the link and the environments. Read-only |
|
|
34
|
+
| The prompt `godaddy-test-then-deploy` | `ai-prompts/` | The launch command of a session that checks a site, runs its webship-js suite when it has one, and gives the deploy line |
|
|
35
|
+
|
|
36
|
+
The plugin keeps its one command, `cmd-tools-godaddy.sh`; no other was added. The item bodies are plain Markdown any AI command-line assistant can follow; Claude Code is the default shape (frontmatter, the launch command of the prompt). A site that carries a webship-js suite is tested by the workspace's own `cmd-tools-testing.sh <project> --run` before a deploy, when it is there.
|
|
37
|
+
|
|
38
|
+
How the items are laid out and checked: [docs/plugin-items-pattern.md](docs/plugin-items-pattern.md).
|
|
39
|
+
|
|
40
|
+
## What it needs
|
|
41
|
+
|
|
42
|
+
A workspace starts empty, so the manifest says what else this plugin needs (`needs`):
|
|
43
|
+
|
|
44
|
+
- one sites folder: `dev`, `test`, `demos`, `sandboxes`, `projects` (`dev` is the one added when none is there). `cmd-tools-godaddy.sh`, which the menu's verbs run, is placed in it, and the menu is on its project rows.
|
|
45
|
+
- on the machine: `curl`, `python3`. A part of it also uses `ssh`, `rsync`.
|
|
46
|
+
|
|
47
|
+
`--require` says so, `--activate` and `--install` stop until the workspace has a sites folder, and `--with-needs` adds it first. A missing command is said and never added:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
bash core/scripts/plugins.sh --activate godaddy --with-needs
|
|
51
|
+
bash core/scripts/plugins.sh --check godaddy # each command: found, with its version, or missing, with how to install it
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
A workspace that knows none of this (Webship Workspace 1.0.8 and older) ignores the keys: add a sites folder yourself, then `--install godaddy` again.
|
|
55
|
+
|
|
56
|
+
It also needs the AI folders its items are placed in (`needs.plugins`): `ai-agents`, `ai-skills`, `ai-commands` and `ai-prompts`, beside the sites folder. `--with-needs` adds what is missing first. A kind whose folder is not an active workspace folder is skipped, and the install says so.
|
|
57
|
+
|
|
23
58
|
## The command
|
|
24
59
|
|
|
25
60
|
```bash
|
|
@@ -57,5 +92,10 @@ the project is linked and which environment it works against.
|
|
|
57
92
|
| `scripts/args/arg-godaddy.sh` | Its argparse |
|
|
58
93
|
| `scripts/host-install.sh` | The host side: the CLI and the credential check |
|
|
59
94
|
| `config/plugin.godaddy.settings.yml` | The settings template |
|
|
95
|
+
| `ai/agents/godaddy-deployer.md` | The agent `godaddy-deployer` |
|
|
96
|
+
| `ai/skills/godaddy-hosting/` | The skill `godaddy-hosting` |
|
|
97
|
+
| `ai/commands/godaddy-status.md` | The command `/godaddy-status` |
|
|
98
|
+
| `ai/prompts/godaddy-test-then-deploy.md` | The prompt `godaddy-test-then-deploy` |
|
|
99
|
+
| `tests/items.test.ts` | The shape of every item, and that it names nothing the plugin does not have |
|
|
60
100
|
|
|
61
101
|
The `workspacePlugin` block in `package.json` is the manifest the installer reads.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: godaddy-deployer
|
|
3
|
+
description: Use this agent to look after a Webship Workspace site on GoDaddy with the command of the GoDaddy plugin (`@webship.co/workspace-godaddy`), `cmd-tools-godaddy.sh` — say whether the project is linked and to what, list its environments, read its log, bring the live database or files into the local site when asked, test the site before a deploy when it carries a webship-js suite, and hand the person the deploy line. It never deploys on its own: a deploy is outward-facing and asks for a confirmation in a terminal. It never prints a token or a key, never relinks a project and never skips the safety backup unless the person said so. Invoke for "is this site linked to GoDaddy", "which environments does it have", "what was deployed last", "get the live database", "is it ready to deploy", or "give me the deploy command".
|
|
4
|
+
model: fable
|
|
5
|
+
tools:
|
|
6
|
+
- Bash
|
|
7
|
+
- Read
|
|
8
|
+
- Glob
|
|
9
|
+
- Grep
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# godaddy-deployer
|
|
13
|
+
|
|
14
|
+
You look after the sites of a Webship Workspace (`~/workspace`), a container-based workspace
|
|
15
|
+
(DDEV by default), on GoDaddy. You come with the GoDaddy plugin (`@webship.co/workspace-godaddy`), a provider of the hosting
|
|
16
|
+
family (`@webship.co/workspace-hosting`), and you work with its command, `cmd-tools-godaddy.sh`, which is
|
|
17
|
+
placed in the sites folders of the workspace. Every entry of the GODADDY menu of a project row runs
|
|
18
|
+
that same command.
|
|
19
|
+
|
|
20
|
+
## Before anything else
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
cd ~/workspace
|
|
24
|
+
bash core/scripts/plugins.sh --check godaddy # the commands it needs on the machine: found, or missing with how to install them
|
|
25
|
+
cd ~/workspace/<folder>
|
|
26
|
+
ls cmd-tools-godaddy.sh # not there: the plugin is not installed for this folder; stop and say so
|
|
27
|
+
bash cmd-tools-godaddy.sh <project> # linked or not, and to what
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
- "not linked": say so, with the line it prints. Linking is done once, by the person or when they
|
|
31
|
+
give you the id: `bash cmd-tools-godaddy.sh <project> --link example.com,user@host:/home/user/public_html`.
|
|
32
|
+
- A command that is missing on the machine: stop and say which, with where to get it.
|
|
33
|
+
- The credential is api_key and api_secret in core/config/plugin.godaddy.settings.yml. Never read it, print it or copy it. When the provider
|
|
34
|
+
refuses it, say that this is where it is set.
|
|
35
|
+
|
|
36
|
+
## Read
|
|
37
|
+
|
|
38
|
+
These change nothing, here or on GoDaddy:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
bash cmd-tools-godaddy.sh <project> --environments
|
|
42
|
+
bash cmd-tools-godaddy.sh <project> --dns
|
|
43
|
+
bash cmd-tools-godaddy.sh <project> --logs
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Bring the live data here
|
|
47
|
+
|
|
48
|
+
Only when the person asked for it. It is client data, and it lands on this machine.
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
bash cmd-tools-godaddy.sh <project> --environment <environment> --pull-db
|
|
52
|
+
bash cmd-tools-godaddy.sh <project> --environment <environment> --pull-files
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
- The database: Dump the site's database over SSH (drush sql:dump in the remote docroot) and import it into DDEV. REPLACES the local database — the current one is exported to backups/ first. Client data.
|
|
56
|
+
- The files: rsync the remote sites/default/files into the local docroot (adds and overwrites, never deletes). Client data.
|
|
57
|
+
- Never add `--no-safety-backup` unless the person said so: it skips the export of the local database that the pull replaces.
|
|
58
|
+
|
|
59
|
+
## Before a deploy
|
|
60
|
+
|
|
61
|
+
A deploy sends what the project holds to GoDaddy. Look first, and say what you found:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
cd ~/workspace/<folder>/<project> && git status --short && git branch --show-current
|
|
65
|
+
cd ~/workspace/<folder>
|
|
66
|
+
ls cmd-tools-testing.sh <project>/cucumber.js # a webship-js suite? both must be there; if not, say so and go on
|
|
67
|
+
bash cmd-tools-testing.sh <project> --run
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Uncommitted changes, the branch, the environment the project works against, and the totals of the
|
|
71
|
+
suite when there is one. A suite that fails is said before anything else: the person decides.
|
|
72
|
+
|
|
73
|
+
## Hand over, never run
|
|
74
|
+
|
|
75
|
+
The deploy asks for a confirmation in a terminal, and it is the person's to give. Give them the
|
|
76
|
+
line, with `cd ~/workspace/<folder> &&` in front, and stop there:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
bash cmd-tools-godaddy.sh <project> --push
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Rules
|
|
83
|
+
|
|
84
|
+
- Never `--push` on your own, and never answer its question for the person.
|
|
85
|
+
- Never `--link` to an id the person did not give, and never `--force`: it relinks a project that already points somewhere else.
|
|
86
|
+
- One project at a time, named by the person.
|
|
87
|
+
- What the command prints about a refused credential is a finding: report it, do not work around it.
|
|
88
|
+
- Say what was not run. A deploy you did not see end is not deployed.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Say where a Webship Workspace site stands on GoDaddy — whether it is linked and to what, and its environments — with the read-only options of the plugin's command. Nothing is linked, pulled or deployed.
|
|
3
|
+
argument-hint: '<project>'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# /godaddy-status
|
|
7
|
+
|
|
8
|
+
Say where this site stands on GoDaddy: `$ARGUMENTS`
|
|
9
|
+
|
|
10
|
+
The argument is one word: the project, which is its folder name in a sites folder of the
|
|
11
|
+
workspace. With no project, stop and ask for one.
|
|
12
|
+
|
|
13
|
+
The workspace is container-based (DDEV by default); the command of the GoDaddy plugin (`@webship.co/workspace-godaddy`) runs
|
|
14
|
+
on the machine, from the sites folder. This command only reads: never run `cmd-tools-godaddy.sh` with
|
|
15
|
+
`--push`, `--link`, `--select`, `--pull-db`, `--pull-files` here, and never print a token or a key.
|
|
16
|
+
|
|
17
|
+
## 1. Find the project and the command
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
ls -d ~/workspace/*/<project>
|
|
21
|
+
cd ~/workspace/<folder>
|
|
22
|
+
ls cmd-tools-godaddy.sh
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
If the command is not there, stop: the plugin is not installed, or the folder is not a sites folder.
|
|
26
|
+
|
|
27
|
+
## 2. Is it linked
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bash cmd-tools-godaddy.sh <project>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
If it says "not linked", say so with the line it prints for linking, and stop.
|
|
34
|
+
|
|
35
|
+
## 3. Read
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
bash cmd-tools-godaddy.sh <project> --environments
|
|
39
|
+
bash cmd-tools-godaddy.sh <project> --dns
|
|
40
|
+
bash cmd-tools-godaddy.sh <project> --logs
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## 4. Report
|
|
44
|
+
|
|
45
|
+
What the project is linked to, the environments with their state and address, and
|
|
46
|
+
anything the command said it could not do, in its own words (a missing command, a refused
|
|
47
|
+
credential).
|
|
48
|
+
|
|
49
|
+
For a deploy or for getting the live data, hand over to the agent `godaddy-deployer`.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
Check a site before it goes to GoDaddy: its link, its environments, its webship-js suite, then the deploy line.
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
claude --permission-mode bypassPermissions """
|
|
5
|
+
Get the site <project> ready to deploy to GoDaddy, and give me the deploy line
|
|
6
|
+
# ~/workspace/<folder> · container-based (DDEV by default) · <folder> is the sites folder of <project>
|
|
7
|
+
# do not deploy: the deploy asks for a confirmation in a terminal and that is mine to give
|
|
8
|
+
# never print a token or a key; link nothing, pull nothing
|
|
9
|
+
|
|
10
|
+
1. cd ~/workspace/<folder> ; bash cmd-tools-godaddy.sh <project>
|
|
11
|
+
stop if it is not linked, and show me the line it prints for linking
|
|
12
|
+
2. bash cmd-tools-godaddy.sh <project> --environments
|
|
13
|
+
tell me which environment the project works against
|
|
14
|
+
3. cd <project> ; git status --short ; git branch --show-current ; cd ..
|
|
15
|
+
tell me what is not committed
|
|
16
|
+
4. if cmd-tools-testing.sh and <project>/cucumber.js are both there:
|
|
17
|
+
bash cmd-tools-testing.sh <project> --run
|
|
18
|
+
and keep the totals it prints; if they are not there, say so and do not invent a test run
|
|
19
|
+
|
|
20
|
+
Then tell me: the link, the environment, what is not committed, and the totals of the suite or
|
|
21
|
+
that there is none. If the suite failed, say that first.
|
|
22
|
+
Last, the line for me to run, and nothing more:
|
|
23
|
+
cd ~/workspace/<folder> && bash cmd-tools-godaddy.sh <project> --push
|
|
24
|
+
"""
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The text between the triple quotes is plain: it can be given to another AI command-line assistant as it is.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: godaddy-hosting
|
|
3
|
+
description: Work with a Webship Workspace site on GoDaddy through the GoDaddy plugin (`@webship.co/workspace-godaddy`) — the GODADDY menu of a project row and the command behind every entry, `cmd-tools-godaddy.sh`, with each of its options, how a project is linked, the keys of `plugin.godaddy.settings.yml` and the credential they hold, and what the command says when something is missing. Use when asked "is this site linked to GoDaddy", "link this project", "list the environments", "what was deployed last", "get the live database", "deploy this site", "the menu says not linked", or "where does the GoDaddy token go".
|
|
4
|
+
argument-hint: '<project>'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# godaddy-hosting
|
|
8
|
+
|
|
9
|
+
GoDaddy for a site of a Webship Workspace (`~/workspace`, container-based, DDEV by default). It comes
|
|
10
|
+
with the GoDaddy plugin (`@webship.co/workspace-godaddy`), a provider of the hosting family (`@webship.co/workspace-hosting`),
|
|
11
|
+
like the agent `godaddy-deployer`, the command `/godaddy-status` and the prompt `godaddy-test-then-deploy`.
|
|
12
|
+
|
|
13
|
+
## The GODADDY menu
|
|
14
|
+
|
|
15
|
+
The GODADDY menu is on the project rows of the sites folders. The caption beside it says `linked`
|
|
16
|
+
or `not linked`. A project that is not linked is shown how to link it; a linked one gets these
|
|
17
|
+
entries, and each of them runs the command of the plugin in a terminal session, from the sites
|
|
18
|
+
folder:
|
|
19
|
+
|
|
20
|
+
| Menu entry | The command |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| **Link, domain and DNS** | `bash cmd-tools-godaddy.sh <project>` |
|
|
23
|
+
| **All DNS records** | `bash cmd-tools-godaddy.sh <project> --dns` |
|
|
24
|
+
| **Last 50 lines of error_log** | `bash cmd-tools-godaddy.sh <project> --logs` |
|
|
25
|
+
| **Deploy with rsync…** | `bash cmd-tools-godaddy.sh <project> --push` |
|
|
26
|
+
|
|
27
|
+
The menu ends with the note "The domain and DNS come from the GoDaddy API; the pulls, the deploy and the log need the hosting account over SSH".
|
|
28
|
+
|
|
29
|
+
### Get the live data
|
|
30
|
+
|
|
31
|
+
The menu also offers to get the database and the files of an environment into the local site. From a terminal:
|
|
32
|
+
|
|
33
|
+
| What | The command | What it does |
|
|
34
|
+
| --- | --- | --- |
|
|
35
|
+
| The database | `bash cmd-tools-godaddy.sh <project> --environment <environment> --pull-db` | Dump the site's database over SSH (drush sql:dump in the remote docroot) and import it into DDEV. REPLACES the local database — the current one is exported to backups/ first. Client data. |
|
|
36
|
+
| The files | `bash cmd-tools-godaddy.sh <project> --environment <environment> --pull-files` | rsync the remote sites/default/files into the local docroot (adds and overwrites, never deletes). Client data. |
|
|
37
|
+
|
|
38
|
+
## The command
|
|
39
|
+
|
|
40
|
+
`cmd-tools-godaddy.sh` is placed in every sites folder of the workspace. The first word after it is the
|
|
41
|
+
project; with nothing else it says whether the project is linked, and to what.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
cd ~/workspace/<folder>
|
|
45
|
+
bash cmd-tools-godaddy.sh <project>
|
|
46
|
+
bash cmd-tools-godaddy.sh <project> --link example.com,user@host:/home/user/public_html
|
|
47
|
+
bash cmd-tools-godaddy.sh <project> --environments
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
| Option | What it does |
|
|
51
|
+
| --- | --- |
|
|
52
|
+
| `--link <value>` | Link the project to a domain in the GoDaddy account, and its hosting over SSH: domain[,user@host:/remote/docroot]. The SSH part is needed for the pulls, the deploy and the log. |
|
|
53
|
+
| `--push` | Deploy: rsync the local docroot to the remote document root (excludes sites/default/files, settings.php, .git, .ddev; deletes what is gone locally). Outward-facing: asks before syncing. |
|
|
54
|
+
| `--environment <value>` | The domain for THIS run (the linked one, or one of its subdomains in DNS). Default: the one remembered by --select. |
|
|
55
|
+
| `--environments` | Show the domain (status, expiry, name servers) and its A/CNAME records, each a site. |
|
|
56
|
+
| `--select <value>` | Remember which host name this project works against (in .godaddy/workspace.yml, git-excluded). Checked against the DNS records. |
|
|
57
|
+
| `--dns` | List every DNS record of the domain. |
|
|
58
|
+
| `--pull-db` | Dump the site's database over SSH (drush sql:dump in the remote docroot) and import it into DDEV. REPLACES the local database — the current one is exported to backups/ first. Client data. |
|
|
59
|
+
| `--pull-files` | rsync the remote sites/default/files into the local docroot (adds and overwrites, never deletes). Client data. |
|
|
60
|
+
| `--logs` | Show the last 50 lines of the site's error_log over SSH. |
|
|
61
|
+
| `--no-safety-backup` | Skip exporting the local database before --pull-db replaces it. |
|
|
62
|
+
| `--force` | Allow --link to relink a project that already points at a different domain. |
|
|
63
|
+
|
|
64
|
+
With no project the command says that `PROJECT_NAME` is required; with a project that is not in
|
|
65
|
+
the folder, "No such project"; with an option that needs a link on a project that has none, "Not
|
|
66
|
+
linked to GoDaddy".
|
|
67
|
+
|
|
68
|
+
## Link a project
|
|
69
|
+
|
|
70
|
+
A project is linked to a domain of the GoDaddy account, and to its hosting over SSH: `domain`, optionally followed by a comma and `user@host:/remote/docroot`. The link is written to `.godaddy/workspace.yml` in the project, which git does not track. A GoDaddy link is the domain, optionally followed by a comma and the hosting account as user@host:/remote/docroot.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
bash cmd-tools-godaddy.sh <project> --link example.com,user@host:/home/user/public_html
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## The settings: `core/config/plugin.godaddy.settings.yml`
|
|
77
|
+
|
|
78
|
+
| Key | What it is |
|
|
79
|
+
| --- | --- |
|
|
80
|
+
| `api_key:` | A production API key from developer.godaddy.com → API Keys. Sent as sso-key KEY:SECRET. |
|
|
81
|
+
| `api_secret:` | The secret of that key. |
|
|
82
|
+
| `ssh_key:` | The private key the pulls and deploys use to reach the hosting account over SSH. Default: ~/.ssh/id_ed25519. |
|
|
83
|
+
|
|
84
|
+
The dashboard reaches GoDaddy with api_key and api_secret in core/config/plugin.godaddy.settings.yml. The file is created mode 600 and its secrets are
|
|
85
|
+
masked on the Settings page. Never print them, never copy them into another file, and never commit
|
|
86
|
+
the file.
|
|
87
|
+
|
|
88
|
+
## Turn it on, and check it
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
cd ~/workspace
|
|
92
|
+
bash core/scripts/plugins.sh --require @webship.co/workspace-godaddy
|
|
93
|
+
bash core/scripts/plugins.sh --activate godaddy --with-needs # adds a sites folder and the AI folders when they are missing
|
|
94
|
+
bash core/scripts/plugins.sh --install godaddy
|
|
95
|
+
bash core/scripts/plugins.sh --configure godaddy
|
|
96
|
+
bash core/scripts/plugins.sh --check godaddy # the commands it needs on the machine
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Traps
|
|
100
|
+
|
|
101
|
+
- **Two ways in, for two things.** The domain and its DNS records come from the GoDaddy API with `api_key:` and `api_secret:` (a production key from developer.godaddy.com, API Keys); the pulls, the deploy and the log need the hosting account over SSH, with the key in `ssh_key:`.
|
|
102
|
+
- **A link with the domain only** shows the domain and its DNS, and nothing more: the pulls, the deploy and the log need the SSH part of the link.
|
|
103
|
+
- **"UNABLE_TO_AUTHENTICATE" or "ACCESS_DENIED"**: the key is refused, or it is not a production key.
|
|
104
|
+
- **A deploy is an rsync that deletes**: it syncs the local docroot to the remote document root and removes there what is gone here. It leaves `sites/default/files`, `settings.php`, `.git` and `.ddev` alone, and asks before it syncs.
|
|
105
|
+
- **The database pull runs `drush sql:dump` in the remote docroot**, over SSH: the site there needs drush. It replaces the local database; the current one is exported to `backups/` first, unless `--no-safety-backup` was given.
|
|
106
|
+
- **An environment here is a host name**: the linked domain, or one of its A or CNAME records.
|
|
107
|
+
- **A deploy is outward-facing.** The command asks before it sends anything, in a terminal: it is
|
|
108
|
+
not a step for an AI assistant to take on its own.
|
package/dist/src/index.d.ts
CHANGED
|
@@ -13,4 +13,9 @@ import type { PluginApi } from '@webship.co/workspace-plugin-api';
|
|
|
13
13
|
import { godaddyProvider } from './lib/provider';
|
|
14
14
|
export { godaddyProvider };
|
|
15
15
|
export { godaddyLinkOf } from './lib/link';
|
|
16
|
+
/** The AI items the installer places: agents in ai-agents/, skills in ai-skills/, commands in ai-commands/, prompts in ai-prompts/. */
|
|
17
|
+
export declare const AGENTS: string[];
|
|
18
|
+
export declare const SKILLS: string[];
|
|
19
|
+
export declare const AI_COMMANDS: string[];
|
|
20
|
+
export declare const PROMPTS: string[];
|
|
16
21
|
export declare function register(api: PluginApi): void;
|
package/dist/src/index.js
CHANGED
|
@@ -11,13 +11,18 @@
|
|
|
11
11
|
* the dashboard's own files.
|
|
12
12
|
*/
|
|
13
13
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
-
exports.godaddyLinkOf = exports.godaddyProvider = void 0;
|
|
14
|
+
exports.PROMPTS = exports.AI_COMMANDS = exports.SKILLS = exports.AGENTS = exports.godaddyLinkOf = exports.godaddyProvider = void 0;
|
|
15
15
|
exports.register = register;
|
|
16
16
|
const workspace_hosting_1 = require("@webship.co/workspace-hosting");
|
|
17
17
|
const provider_1 = require("./lib/provider");
|
|
18
18
|
Object.defineProperty(exports, "godaddyProvider", { enumerable: true, get: function () { return provider_1.godaddyProvider; } });
|
|
19
19
|
var link_1 = require("./lib/link");
|
|
20
20
|
Object.defineProperty(exports, "godaddyLinkOf", { enumerable: true, get: function () { return link_1.godaddyLinkOf; } });
|
|
21
|
+
/** The AI items the installer places: agents in ai-agents/, skills in ai-skills/, commands in ai-commands/, prompts in ai-prompts/. */
|
|
22
|
+
exports.AGENTS = ['godaddy-deployer'];
|
|
23
|
+
exports.SKILLS = ['godaddy-hosting'];
|
|
24
|
+
exports.AI_COMMANDS = ['godaddy-status'];
|
|
25
|
+
exports.PROMPTS = ['godaddy-test-then-deploy'];
|
|
21
26
|
function register(api) {
|
|
22
27
|
(0, workspace_hosting_1.registerHosting)(api, (0, provider_1.godaddyProvider)(api));
|
|
23
28
|
}
|
package/dist/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAgBH,4BAEC;AAfD,qEAAgE;AAEhE,6CAAiD;AAExC,gGAFA,0BAAe,OAEA;AACxB,mCAA2C;AAAlC,qGAAA,aAAa,OAAA;AAEtB,uIAAuI;AAC1H,QAAA,MAAM,GAAa,CAAC,kBAAkB,CAAC,CAAC;AACxC,QAAA,MAAM,GAAa,CAAC,iBAAiB,CAAC,CAAC;AACvC,QAAA,WAAW,GAAa,CAAC,gBAAgB,CAAC,CAAC;AAC3C,QAAA,OAAO,GAAa,CAAC,0BAA0B,CAAC,CAAC;AAE9D,SAAgB,QAAQ,CAAC,GAAc;IACrC,IAAA,mCAAe,EAAC,GAAG,EAAE,IAAA,0BAAe,EAAC,GAAG,CAAC,CAAC,CAAC;AAC7C,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# A plugin carries its own items
|
|
2
|
+
|
|
3
|
+
Every `@webship.co/workspace-<name>` plugin manages what belongs to it: its `cmd-*.sh` commands and
|
|
4
|
+
its AI items (agents, skills, commands, prompts). The package holds them under `ai/`, one folder per
|
|
5
|
+
kind, the manifest names them (`ai`) and the AI folder each kind lands in (`needs`), and
|
|
6
|
+
`plugins.sh --install godaddy` lists each one in the workspace folder of its kind, when that folder is
|
|
7
|
+
an active workspace folder. `--uninstall` takes them away again.
|
|
8
|
+
|
|
9
|
+
The shape, what an item may say and how it is proven on a fresh workspace are described once, in
|
|
10
|
+
the reference for a plugin that is not a platform:
|
|
11
|
+
[`@webship.co/workspace-github`, docs/plugin-items-pattern.md](https://github.com/webship/workspace-github/blob/1.0.x/docs/plugin-items-pattern.md).
|
|
12
|
+
|
|
13
|
+
What is specific here is in `tests/items.test.ts`: the items of this plugin are held to what the
|
|
14
|
+
plugin itself draws, runs and reads — its menu entries, its settings keys, its commands and flags.
|
package/features/godaddy.feature
CHANGED
|
@@ -18,3 +18,19 @@ Feature: The GoDaddy plugin on a project row
|
|
|
18
18
|
Given I am on "/settings/plugins"
|
|
19
19
|
Then I should see "GoDaddy"
|
|
20
20
|
And I should see "@webship.co/workspace-godaddy"
|
|
21
|
+
|
|
22
|
+
Scenario: The AI Agents folder lists the agent the plugin ships
|
|
23
|
+
Given I am on "/ai-agents"
|
|
24
|
+
Then I should see "godaddy-deployer"
|
|
25
|
+
|
|
26
|
+
Scenario: The AI Skills folder lists the skill the plugin ships
|
|
27
|
+
Given I am on "/ai-skills"
|
|
28
|
+
Then I should see "godaddy-hosting"
|
|
29
|
+
|
|
30
|
+
Scenario: The AI Commands folder lists the command the plugin ships
|
|
31
|
+
Given I am on "/ai-commands"
|
|
32
|
+
Then I should see "godaddy-status"
|
|
33
|
+
|
|
34
|
+
Scenario: The AI Prompts folder lists the prompt the plugin ships
|
|
35
|
+
Given I am on "/ai-prompts"
|
|
36
|
+
Then I should see "godaddy-test-then-deploy"
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webship.co/workspace-godaddy",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "GoDaddy for Webship Workspace: the GODADDY menu on every site row, the domain and its DNS from the GoDaddy API, the hosting account over SSH (get database and files, deploy with rsync, the error log), the GoDaddy console. A provider of @webship.co/workspace-hosting.",
|
|
3
|
+
"version": "1.0.9",
|
|
4
|
+
"description": "GoDaddy for Webship Workspace: the GODADDY menu on every site row, the domain and its DNS from the GoDaddy API, the hosting account over SSH (get database and files, deploy with rsync, the error log), the GoDaddy console. It carries its AI items, each placed in the workspace folder of its kind: an agent, a skill, a command and a prompt. A provider of @webship.co/workspace-hosting.",
|
|
5
5
|
"main": "dist/src/index.js",
|
|
6
6
|
"types": "dist/src/index.d.ts",
|
|
7
7
|
"license": "ISC",
|
|
@@ -11,11 +11,13 @@
|
|
|
11
11
|
},
|
|
12
12
|
"files": [
|
|
13
13
|
"dist/src",
|
|
14
|
+
"ai",
|
|
14
15
|
"commands",
|
|
15
16
|
"config",
|
|
16
17
|
"features",
|
|
17
18
|
"scripts",
|
|
18
|
-
"README.md"
|
|
19
|
+
"README.md",
|
|
20
|
+
"docs"
|
|
19
21
|
],
|
|
20
22
|
"scripts": {
|
|
21
23
|
"build": "tsc -p tsconfig.json",
|
|
@@ -26,6 +28,31 @@
|
|
|
26
28
|
"workspacePlugin": {
|
|
27
29
|
"name": "godaddy",
|
|
28
30
|
"label": "GoDaddy",
|
|
31
|
+
"needs": {
|
|
32
|
+
"plugins": [
|
|
33
|
+
[
|
|
34
|
+
"dev",
|
|
35
|
+
"test",
|
|
36
|
+
"demos",
|
|
37
|
+
"sandboxes",
|
|
38
|
+
"projects"
|
|
39
|
+
],
|
|
40
|
+
"ai-agents",
|
|
41
|
+
"ai-skills",
|
|
42
|
+
"ai-commands",
|
|
43
|
+
"ai-prompts"
|
|
44
|
+
],
|
|
45
|
+
"commands": [
|
|
46
|
+
"curl",
|
|
47
|
+
"python3"
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
"suggests": {
|
|
51
|
+
"commands": [
|
|
52
|
+
"ssh",
|
|
53
|
+
"rsync"
|
|
54
|
+
]
|
|
55
|
+
},
|
|
29
56
|
"settingsFile": "plugin.godaddy.settings.yml",
|
|
30
57
|
"settingsTemplate": "config/plugin.godaddy.settings.yml",
|
|
31
58
|
"labels": "config/settings.labels.yml",
|
|
@@ -60,6 +87,20 @@
|
|
|
60
87
|
],
|
|
61
88
|
"hostInstall": "scripts/host-install.sh"
|
|
62
89
|
},
|
|
90
|
+
"ai": {
|
|
91
|
+
"agents": [
|
|
92
|
+
"ai/agents/godaddy-deployer.md"
|
|
93
|
+
],
|
|
94
|
+
"skills": [
|
|
95
|
+
"ai/skills/godaddy-hosting"
|
|
96
|
+
],
|
|
97
|
+
"commands": [
|
|
98
|
+
"ai/commands/godaddy-status.md"
|
|
99
|
+
],
|
|
100
|
+
"prompts": [
|
|
101
|
+
"ai/prompts/godaddy-test-then-deploy.md"
|
|
102
|
+
]
|
|
103
|
+
},
|
|
63
104
|
"features": [
|
|
64
105
|
"features/godaddy.feature"
|
|
65
106
|
]
|
|
@@ -27,7 +27,7 @@ parser.add_argument('-n', '--dns',
|
|
|
27
27
|
parser.add_argument('-D', '--pull-db',
|
|
28
28
|
action='store_true',
|
|
29
29
|
default=False,
|
|
30
|
-
help='Dump the site's database over SSH (drush sql:dump in the remote docroot) and import it into DDEV. REPLACES the local database — the current one is exported to backups/ first. Client data.')
|
|
30
|
+
help='Dump the site\'s database over SSH (drush sql:dump in the remote docroot) and import it into DDEV. REPLACES the local database — the current one is exported to backups/ first. Client data.')
|
|
31
31
|
parser.add_argument('-F', '--pull-files',
|
|
32
32
|
action='store_true',
|
|
33
33
|
default=False,
|
|
@@ -35,7 +35,7 @@ parser.add_argument('-F', '--pull-files',
|
|
|
35
35
|
parser.add_argument('-g', '--logs',
|
|
36
36
|
action='store_true',
|
|
37
37
|
default=False,
|
|
38
|
-
help='Show the last 50 lines of the site's error_log over SSH.')
|
|
38
|
+
help='Show the last 50 lines of the site\'s error_log over SSH.')
|
|
39
39
|
parser.add_argument('-B', '--no-safety-backup',
|
|
40
40
|
action='store_true',
|
|
41
41
|
default=False,
|