-
Notifications
You must be signed in to change notification settings - Fork 3
feat(cli): prepare npm release #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,38 @@ | ||
| # OOXML CLI | ||
|
|
||
| Use the OOXML reference from a terminal or an agent skill. Sign in with Clerk to query the hosted ooxml.dev service. | ||
| Use the OOXML reference from a terminal or an agent skill. | ||
|
|
||
| While the package is private, run it from the repository root: | ||
| ## Install | ||
|
|
||
| Node.js 20 or later is required. | ||
|
|
||
| ```bash | ||
| bun run ooxml login | ||
| bun run ooxml search "paragraph spacing" | ||
| bun run ooxml element w:p | ||
| bun run ooxml children w:p | ||
| bun run ooxml attributes w:p | ||
| bun run ooxml logout | ||
| npm install --global @ooxml-dev/cli | ||
| ``` | ||
|
|
||
| During this private test, the CLI stores sign-in tokens as plain text in your application data directory. Do not use it from a shared account. The CLI does not store queries or results. | ||
| ## Use the CLI | ||
|
|
||
| The bundled [`research-ooxml`](../../skills/research-ooxml/SKILL.md) skill tells agents which commands to use and how to combine schema and specification evidence. | ||
| Sign in, then query the reference: | ||
|
|
||
| MCP is an internal transport detail. It is not part of the CLI or skill interface. | ||
| ```bash | ||
| ooxml login | ||
| ooxml search "paragraph spacing" | ||
| ooxml element w:p | ||
| ooxml children w:p | ||
| ooxml attributes w:p | ||
| ooxml logout | ||
| ``` | ||
|
|
||
| The CLI uses the production ooxml.dev service. You may need to create an account and sign in. Sign-in is only used to control usage; the service is free. | ||
|
|
||
| The CLI stores sign-in tokens as plain text in your application data directory. Do not use it from a shared account. It does not store queries or results. | ||
|
|
||
| The package remains private while we test it. Secure credential storage and npm publishing are separate release steps. | ||
| ## Install the agent skill | ||
|
|
||
| The bundled [`research-ooxml`](../../skills/research-ooxml/SKILL.md) skill tells coding agents which commands to use and how to combine schema and specification evidence. | ||
|
|
||
| ```bash | ||
| npx skills add superdoc/ooxml-dev --skill research-ooxml -g -y | ||
| ``` | ||
|
|
||
| MCP is an internal transport detail. It is not part of the CLI or skill interface. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.