Documentation

Cheats

A cheat is something you want to find again: a command, a piece of code, a config, a short explanation. Each one has a title, a type, and a body, and it can carry links.

Cheats are the only section that is public by default, and the only one with a revision history you can open.

Concepts

Type. The filing label. The filters along the top of the Cheats view are the types in use. Search can be limited to one type. A type name allows letters, digits, spaces, and + & * % # . : ; -.

Public and private. A new cheat is public unless you mark it private. Public cheats can be starred and voted on, and they appear in search for everyone. A private cheat stays on your account. An account you have linked can see it too. Making a public cheat private takes it out of everyone else's search.

Stars and votes. A star saves a public cheat to your stars. A vote is a point up or down on that revision. Stars and points carry forward when you edit, so a revision does not start from zero. If another revision of the same cheat has more of its own likes, the cheat says so, and you can open that revision.

Revision history. Saving an edit keeps the previous version and writes a new one. Open the history from the cheat. The older version stays readable. There is no in-place overwrite.

Share link. Separate from public and private. On the cheat, Share settings chooses who can open its link.

Who can view this linkWhat happens
Only meThe link is yours
Anyone with the linkOpening the link is enough
Specific peopleThey must sign in with a matching email. Each address is emailed when you save. An address with no account yet is kept, and the link opens once they sign up with it

Sharing sends that email. It is not queued for later if you are offline.

The box at the top of the Cheats view searches the cheats you can see: public cheats, your own, and private cheats from a linked account.

It matches the title, the body, and the URLs of a cheat's links. A type filter narrows the same search. Sort is the control beside the search box.

An empty search is the recent list, not an error.

Create and edit

  1. Add a cheat from the Cheats view and give it a title, a type, and a body.
  2. Leave it public, or mark it private.
  3. Add links when the snippet depends on a doc, a repo, or another page. Those URLs are part of search.
  4. Save. A later edit keeps the previous version and opens the new one.

The body is held to 100 lines of up to 600 characters, and the whole cheat to 10 KB. Over a limit, the save is refused and nothing is cut short.

Copy ID on a cheat is the id an assistant or the API uses.

From an assistant

search_cheats, get_cheat, and get_revisions read. add_cheat, update_cheat, and delete_cheat write, and writing needs Pro.

An assistant can change the text. Changing who a cheat is shared with stays on this page, because that emails people.

A key limited to the Cheats section is offered only the cheat tools. That is the connection to use when the assistant should have your snippets as reference and nothing else. See Connect an assistant.

Plans

Free and Pro can both create as many cheats as they want. The caps on Plans apply to the other sections.

Deleting the account removes private cheats. Public cheats you published stay on the service, as public content. Make them private first if they should go too. Account deletion is under User → Termination.

  • Vault when the text must be unreadable even to Cheats.
  • Notes for a list or a private note that should stay out of cheat search.
  • API reference for the cheat endpoints.