{"id":25839667,"url":"https://github.com/netresearch/ckeditor-cowriter","last_synced_at":"2025-03-01T04:33:59.609Z","repository":{"id":65329963,"uuid":"589695920","full_name":"netresearch/ckeditor-cowriter","owner":"netresearch","description":"This plugin generates content with the help of artificial intelligence. It is based on the CKEditor 4. It uses the OpenAI API to generate text.","archived":false,"fork":false,"pushed_at":"2025-02-26T17:47:38.000Z","size":611,"stargazers_count":10,"open_issues_count":1,"forks_count":4,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-02-26T18:42:39.176Z","etag":null,"topics":["ai","ckeditor4","ckeditor4-plugin"],"latest_commit_sha":null,"homepage":"https://ckeditor.com/cke4/addon/cowriter","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netresearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-16T18:09:55.000Z","updated_at":"2025-02-26T17:47:40.000Z","dependencies_parsed_at":"2023-04-27T16:01:44.339Z","dependency_job_id":"ed23f869-b5d6-4ae2-a50e-71409b440465","html_url":"https://github.com/netresearch/ckeditor-cowriter","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fckeditor-cowriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fckeditor-cowriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fckeditor-cowriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fckeditor-cowriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/ckeditor-cowriter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240917259,"owners_count":19878303,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ckeditor4","ckeditor4-plugin"],"created_at":"2025-03-01T04:33:59.064Z","updated_at":"2025-03-01T04:33:59.595Z","avatar_url":"https://github.com/netresearch.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CKEditor 4 Plugin - Cowriter 🤖\n\n[![Release](https://github.com/netresearch/ckeditor-cowriter/actions/workflows/release.yml/badge.svg)](https://github.com/netresearch/ckeditor-cowriter/actions/workflows/release.yml)\n\nThis plugin generates content with the help of artificial intelligence. It is based on the [CKEditor 4](http://ckeditor.com/). It uses the [OpenAI API](https://beta.openai.com/) to generate text. You can use it to generate text for your blog posts, emails, or any other content.\n\n![Cowriter with TYPO3 CMS](docs/images/ckditor-cowriter-animation-100.gif)\n\n\u003e Give it a try and let the AI write for you: [Demo](https://netresearch.github.io/ckeditor-cowriter/)\n\n## Installation\n\nYou can find the plugin in the [CKEditor plugin directory](https://ckeditor.com/cke4/addon/cowriter)\n\n### Installation with [npm](https://www.npmjs.com/package/@netresearch/ckeditor-cowriter)\n\n1. Install the plugin with npm:\n\n    ```bash\n    npm install @netresearch/ckeditor-cowriter --save\n    ```\n\n2. Enable the plugin by using the `extraPlugins` configuration setting. For example:\n\n    ```javascript\n    CKEDITOR.plugins.addExternal('cowriter', '/node_modules/@netresearch/ckeditor-cowriter/dist/', 'plugin.js')\n    CKEDITOR.config.extraPlugins = 'cowriter';\n    ```\n\n### Installation from source\n\n1. Download the [latest release](https://ckeditor.com/cke4/addon/cowriter) of the plugin.\n2. Extract the contents of the archive into a directory. For example: `/plugins/cowriter/`\n3. Enable the plugin by using the `addExternal`and  `extraPlugins` configuration setting. For example:\n\n    ```javascript\n    CKEDITOR.plugins.addExternal('cowriter', '/plugins/cowriter/', 'plugin.js')\n    CKEDITOR.config.extraPlugins = 'cowriter';\n    ```\n\n## Configuration\n\nYou need to define your OpenAI credentials. Do this above the `CKEDITOR.replace` call. For example:\n\n```javascript\nconst OPENAI_KEY = 'YOUR-KEY'\nconst OPENAI_ORG = 'org-YOUR-ORG-KEY'\n```\n\n## Usage\n\n1. Click on the `Cowriter` button in the toolbar.\n2. Enter a prompt.\n3. Click on the `Generate` button.\n4. The generated text will be inserted into the editor.\n\n## License\n\nLicensed under the terms of the [GNU General Public License](http://www.gnu.org/licenses/gpl.html), version 3 or later.\n\n## Credits\n\n- All Contributors\n- This plugin is based on the [CKEditor 4 Plugin - GPT-3](https://github.com/netresearch/ckeditor-cowriter/releases) by [Netresearch](https://www.netresearch.de/).\n- It uses Flaticon's [document](https://www.flaticon.com/) icon.\n\n## Contributing\n\nWe welcome contributions to this project. Please see our [contribution guidelines](CONTRIBUTING.md) for details.\n\n### Security\n\nIf you discover any security related issues, please email \u003cdeveloper@netresearch.de\u003e instead of using the issue tracker!\n\n### Contact\n\n[Netresearch](https://www.netresearch.de/), the company behind this plugin, is a leading European provider of digital solutions and services for the eCommerce industry. We are a team of eCommerce experts, developers, designers, project managers, and consultants. We are passionate about eCommerce and we love to share our knowledge with the community.\n\n\u003e [Twitter](https://twitter.com/netresearch) | [LinkedIn](https://www.linkedin.com/company/netresearch/) | [Facebook](https://www.facebook.com/netresearch/) | [Xing](https://www.xing.com/companies/netresearchdttgmbh) | [YouTube](https://www.youtube.com/@netresearch)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fckeditor-cowriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Fckeditor-cowriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fckeditor-cowriter/lists"}