dotcms 0.0.21 → 0.2.1

package/README.md

@@ -1,95 +1,54 @@
-# JavaScript SDK for DotCMS API's
+# dotcms
 
-This library allows you to interact with DotCMS API's easily from the browser, nodejs and React Native. [Full Documentation](https://dotcms.github.io/core-web/dotcms/)
+One command to connect an AI coding agent to a dotCMS instance.
 
-## Install
-
-`npm install dotcms --save`
-
-or
-
-`yarn install dotcms`
-
-## Usage
-
-```javascript
-import { initDotCMS } from 'dotcms';
-
-const dotcms = initDotCMS({
-    hostId: 'DOTCMS_SITE_IDENTIFIER',
-    host: 'YOUR_DOTCMS_INSTANCE',
-    token: 'YOUR AUTH TOKEN'
-});
-
-// Example
-dotcms.page
-    .get({
-        url: '/about-us'
-    })
-    .then((data) => {
-        console.log(data);
-    })
-    .catch((err) => {
-        console.error(err.status, err.message);
-    });
+```bash
+npx dotcms agent setup
 ```
 
-## Examples
+It asks where your instance is, how to authenticate, and which editors to wire up — then mints
+and verifies a token, writes the dotCMS MCP server into each editor's own config file, installs
+the dotCMS skills, and launches the server to confirm it responds before reporting success.
 
-### Next.js
+Replaces four manual steps: find the admin panel, mint a token by hand, hand-edit whichever
+config file your editor reads, install the skills separately.
 
-Next.js gives you the best developer experience with all the features you need for production. [Read more](https://nextjs.org/)
+## Supported editors
 
-#### Fetching data in the client
+Claude Code · Cursor · VS Code (Copilot) · Codex · Antigravity · Devin · OpenCode
 
-```javascript
-import { useEffect, useState } from 'react';
-import { initDotCMS } from 'dotcms';
+Installed editors are detected and used by default; `--agent <id>` selects specific ones.
 
-const dotcms = initDotCMS({
-    host: 'YOUR_DOTCMS_INSTANCE',
-    token: 'YOUR AUTH TOKEN'
-});
+## Authentication
 
-export default function Home() {
-    const [state, setState] = useState(null);
+Two mutually exclusive modes. Passing both is a usage error, not a silent preference.
 
-    useEffect(async () => {
-        const page = await dotcms.page.get({
-            url: '/index'
-        });
-        setState(page);
-    }, []);
+```bash
+# mint a token from credentials
+npx dotcms agent setup --url https://demo.dotcms.com --user admin@dotcms.com --password '…'
 
-    return state && <h1>{state.page.title}</h1>;
-}
+# or use a token you already have
+npx dotcms agent setup --url https://demo.dotcms.com --authToken '…'
 ```
 
-#### Fetching data in the server
+The URL plus one auth mode are the only required inputs — supply both and the command runs
+without prompting, whether or not a terminal is attached.
 
-```javascript
-import { useEffect, useState } from 'react';
-import { initDotCMS } from 'dotcms';
+> Passing a secret as a flag makes it visible in the process list and shell history. Prefer
+> `DOTCMS_PASSWORD` / `DOTCMS_AUTH_TOKEN`, or let it prompt.
 
-export default function Home(props) {
-    return <h1>{props.page.title}</h1>;
-}
+## Scope
 
-export async function getServerSideProps(context) {
-    const page = await dotcms.page.get({
-        url: context.req.url // you can map the urls with dotcms
-    });
-
-    return {
-        props: page // will be passed to the page component as props
-    };
-}
-```
+Writes to the **current folder** by default, so each project can point at its own instance.
+`-g/--global` writes to your user account instead. Folder scope offers to add the files it
+touched to `.gitignore`, because they contain a token.
 
-More about [data fetching](https://nextjs.org/docs/basic-features/data-fetching) in Nextjs.
+## Where the token goes
 
-## Running unit tests
+Only into the editor config files listed in the summary, restricted to your user where the
+platform supports it. It is never logged in full, never passed as a process argument, and a
+password is never written anywhere.
 
-Run `nx test dotcms` to execute the unit tests.
+## Status
 
-This library was generated with [Nx](https://nx.dev).
+Not yet released. See `specs/37390-dotcms-agent-setup/` for the specification.