Output

🚀Command Output

Recommended

Learn what to expect when Custy initializes a project.

Commandcusty init

📦Category

Initialization

🚀Quick Command

custy init

---

outputterminalmessages

---

Overview

During initialization, Custy reports its progress through informative terminal messages.

These messages help you understand which resources are created, copied, skipped, or overwritten, and whether initialization completed successfully.

💡Readable Output

Custy's output is designed to be human-readable while providing enough information to understand what happened during initialization.

---

Typical Output

💻Command Output

Example output produced after running the command.

Successful Initialization

Typical output when initializing a project for the first time.

Terminal

text

Initializing Custy project...

✓ Configuration created
✓ Templates created
✓ Examples created

Initialization completed successfully.

💡 Next Steps

1. Review .config/custy/config.toml.
2. Set tool.custy.changelog.links.repository if changelog compare links are needed.
3. Verify default_remote, main_remotes, and backup_remotes with git remote -v.
4. Run custy validate.
 

---

💡Notes

The exact wording may differ slightly between Custy versions, but the overall flow remains the same.

Existing Resources

Displayed when Custy preserves existing files while adding a missing packaged example.

Terminal

text

 Skipped .config/custy/config.toml (already exists)
 Skipped .config/custy/templates/commit-message.txt (already exists)
 Copied .config/custy/templates/examples/commit_message/since_custy_v2/new-example.txt

Initialization completed successfully.

---

💡Notes

An existing examples directory is reused. Missing nested files can be copied even when other files are skipped.

Interactive Confirmation

Shown when Custy requires confirmation before replacing an existing resource.

Terminal

text

Configuration already exists.

Overwrite existing file? (y/N)

---

💡Notes

Interactive prompts apply to supported individual generated files. Packaged example files use preserve-or-force merge behavior without per-file prompts.

---

Interpreting the Output

The output shown by Custy depends on several factors, including:

• The selected initialization mode.
• Whether project resources already exist.
• Whether confirmation prompts are enabled.
• Whether resources are overwritten.
• Whether the packaged example tree contains files missing from the project.

Although the exact wording may vary between versions, the overall sequence of messages remains consistent.

---

ℹ️Successful Completion

When initialization finishes successfully, your project is ready for future Custy commands.

The generated configuration and templates can now be reviewed, customized, and committed to version control.

---

What's Next?

Modes that create configuration (all, all_no_examples, and config) finish with a project-specific checklist. Review .config/custy/config.toml, set the changelog browser URL only when comparison links are needed, verify Git remote names with git remote -v, and then run custy validate.

If the initialization process does not behave as expected, continue to the Troubleshooting page for common problems and recommended solutions.