Add incremental document backup

[mg6]

Use codexctl backup --incremental to overwrite out-of-date files only.

Summary by CodeRabbit

• New Features
  • Introduced an incremental backup option that allows selective file updating by overwriting only out-of-date files, while keeping the original backup command intact.
• Documentation
  • Updated user guidance and examples to explain how to use the new incremental backup feature.
• Chores
  • Upgraded a dependency to version 1.2.2 to support the enhanced backup operations.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

An incremental backup feature is introduced to the codexctl backup command. This includes a new --incremental flag, updates to the CLI, and enhancements in the backup logic to skip downloading files that are already up-to-date based on modification timestamps. Documentation is updated with usage examples.

Changes

File(s)	Change Summary
README.md	Added example usage for codexctl backup with the --incremental flag.
codexctl/init.py	Added --incremental CLI flag for backup; passed flag to backup logic in Manager.call_func.
codexctl/sync.py	Enhanced RmWebInterfaceAPI with incremental sync logic: new parameter, timestamp comparison, and method for checking file freshness.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Manager
    participant RmWebInterfaceAPI
    participant FileSystem

    User->>CLI: Run "codexctl backup --incremental"
    CLI->>Manager: Parse args (incremental=True)
    Manager->>RmWebInterfaceAPI: sync(localFolder, ..., incremental=True)
    loop For each document
        RmWebInterfaceAPI->>FileSystem: Check if local file exists
        alt File exists and incremental=True
            RmWebInterfaceAPI->>FileSystem: Compare modification times
            alt Local file is newer
                RmWebInterfaceAPI-->>Manager: Skip download
            else Local file is older
                RmWebInterfaceAPI->>FileSystem: Overwrite local file
            end
        else
            RmWebInterfaceAPI->>FileSystem: Download file
        end
    end
    RmWebInterfaceAPI-->>Manager: Sync complete
    Manager-->>CLI: Done
    CLI-->>User: Backup completed

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74eed583c19fa2b6660489b00ca1e3a7bd68cb41 and 63cea3226215a3e3814c56d5c89b06d59a97aa65.

📒 Files selected for processing (2)

• README.md (1 hunks)
• codexctl/__init__.py (2 hunks)

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[mg6]

Hey @Eeems, anything blocking the merge? Thanks.

[Eeems]

Hey @Eeems, anything blocking the merge? Thanks.

Testing and review by @Jayy001