confluence-cli
llms.txt321 starsChanged 17 months agoMITView on GitHub
A powerful command-line interface for Atlassian Confluence that allows you to read, search, and manage your Confluence content from the terminal. This CLI tool provides a comprehensive set of commands for interacting with Confluence. Key features include creating, reading, updating, and searching for pages. It supports various content formats like markdown and HTML. To get started, install the tool via npm and initialize the configuration: This section summarizes recent improvements to align the codebase with its documentation and fix bugs.
- Installs packages
The file
We split this llms.txt into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 50
If you encounter issues, open an issue or check the FAQ section in the documentation.
≈ “Common” is an estimate: at least 1 in 5 of the 3,592 llms.txt files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
# Confluence CLI
> A powerful command-line interface for Atlassian Confluence that allows you to read, search, and manage your Confluence content from the terminal.
This CLI tool provides a comprehensive set of commands for interacting with Confluence. Key features include creating, reading, updating, and searching for pages. It supports various content formats like markdown and HTML.
To get started, install the tool via npm and initialize the configuration:
```sh
npm install -g confluence-cli
confluence init
```
## Documentation
- [README.md](./README.md): Main documentation with installation, usage, and command reference.
## Core Source Code
- [bin/confluence.js](./bin/confluence.js): The main entry point for the CLI, defines commands and argument parsing.
- [lib/confluence-client.js](./lib/confluence-client.js): The client library for interacting with the Confluence REST API.
- [package.json](./package.json): Project metadata, dependencies, and scripts.
## Recent Changes & Fixes
This section summarizes recent improvements to align the codebase with its documentation and fix bugs.
### Bodyless Content Error Handling:
- **Inconsistency:** `confluence info` could inspect folders, but `read`, `edit`, and title-only `update` crashed when Confluence returned content without `body.storage.value`.
- **Fix:** Added a shared storage-body guard in `lib/confluence-client.js` so these commands fail with `Page <id> has no readable body (it may be a folder or an unsupported content type).`.
### `update` Command Logic and Documentation:
- **Inconsistency:** The `README.md` suggested that updating a page's title without changing its content was possible. However, the implementation in `bin/confluence.js` incorrectly threw an error if the `--content` or `--file` flags were not provided, making title-only updates impossible.
- **Fix:**
- Modified `updatePage` in `lib/confluence-client.js` to fetch and re-use existing page content if no new content is provided.
- Adjusted validation in `bin/confluence.js` for the `update` command to only require one of `--title`, `--content`, or `--file`.
- Updated `README.md` with an example of a title-only update.
### Incomplete `README.md` Command Reference:
- **Inconsistency:** The main command table in `README.md` was missing several commands (`create`, `create-child`, `update`, `edit`, `find`).
- **Fix:** Expanded the command table in `README.md` to include all available commands.
### Misleading `read` Command URL Examples:
- **Inconsistency:** The documentation for the `read` command used "display" or "pretty" URLs, which are not supported by the `extractPageId` function.
- **Fix:** Removed incorrect URL examples and clarified that only URLs with a `pageId` query parameter are supported.
## Next Steps
- Refer to [README.md](./README.md) for detailed usage instructions and advanced configuration.
- For troubleshooting or to contribute, visit the project's GitHub repository at https://github.com/pchuri/confluence-cli.
- If you encounter issues, open an issue or check the FAQ section in the documentation.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.